创建停机计划程序任务

该API允许用户在Applications Manager中创建停机计划。可以使用以下任意重复类型创建计划： 

您可以为业务组以及单个监视器计划维护任务。要为业务组配置计划，只需提供任务类型作为业务组和resourceid作为业务组id即可。 

每天重复发生的停机时间计划

语法

http://[Host]:[Port]/AppManager/xml/CreateMaintenanceTask?apikey=[APIKEY]&taskMethod=daily&taskStartTime=[STARTTIME]& taskEndTime=[ENDTIME]&taskStatus=disable&taskEffectFrom=[DATE]&taskName=[NAME]&taskType=monitor&resourceid=[RESOURCEID]

请求参数

API请求中涉及的参数如下所述。另外，请参阅公共请求参数列表。

字段 描述        
taskMethod 表示维护计划的重复频率，每天表示计划每天运行。
taskStartTime 维护任务开始运行的时间
taskEndTime 维护任务停止运行的时间
taskEffectFrom 维护任务生效的日期和时间
offset 相对于GMT的小时数差异。如果提供的偏移值无效，Applications Manager将使用用户的系统时间作为偏移值。
taskType 要创建的任务的类型。可能的值是监视器（对于单个监视器）和业务组（对于业务组） 。您可以通过将任务类型提供为业务组来为业务组配置计划 。
resourceid  必须为其创建计划的监视器或业务组的资源标识

示例

http://app-windows:9090/AppManager/xml/CreateMaintenanceTask?apikey=bdd4d0643c6f591e123b7ba6fb69d9dd&taskMethod=daily &taskStartTime=20:00&taskEndTime=21:00&taskStatus=disable&taskEffectFrom=2010-05-24%2016:48&taskName=dr1 &taskType=monitor&resourceid=10000055  

以上示例的输出：

<AppManager-response uri="/AppManager/xml/CreateMaintenanceTask">
   <result>
       <response response-code="4000">
         <message>Maintenance Task successfully created.</message>
      </response>
   </result>
</AppManager-response>

每周定期停机时间计划

语法

http://[Host]:[Port]/AppManager/xml/CreateMaintenanceTask?apikey=[APIKEY]&taskType=[TASKTYPE]&resourceid=[RESOURCEID] &totalNumber=[TOTALNUMBER]&taskMethod=[TASKMETHOD]&taskdescribe=[TASKDESCRIBE]&taskStatus=[TASKSTATUS] &taskEffectFrom=[DATETIME]&startDay1=[STARTDAY1]&startTime1=[STARTTIME1]&endDay1=[ENDDAY1]&endTime1=[ENDTIME1] &taskName=[TASKNAME]

请求参数

API请求中涉及的参数如下所述。另外，请参阅公共请求参数列表。

字段 描述        
totalNumber 要创建的计划数。您最多可以创建7个每周计划表
taskMethod 表示维护计划的重复频率，每周表示维护计划每周运行一次。
taskDescription 维护计划的描述，可选值。
taskEffectFrom 维护任务生效的日期和时间
startDay [n] 维护任务开始运行的日期。n的允许值为1,2,3,4,5,6和7
startTime [n] 维护任务开始运行的时间。n的允许值为1,2,3,4,5,6和7
endDay [n] 维护任务停止运行的日期。n的允许值为1,2,3,4,5,6和7
offset 相对于GMT的小时数差异。如果提供的偏移值无效，Applications Manager将使用用户的系统时间作为偏移值。
endTime [n] 维护任务停止运行的时间。n的允许值为1,2,3,4,5,6和7
taskType 要创建的任务的类型。可能的值是监视器（对于单个监视器）和业务组（对于业务组）。您可以通过将任务类型提供为业务组来为业务组配置计划 。
resourceid  必须为其创建计划的监视器或业务组的资源标识

示例

http://app-windows:9090/AppManager/xml/CreateMaintenanceTask?apikey=983a7d7ed56c5753f4977df5883e2b2d&taskType=monitor &resourceid=10000028&totalNumber=1&taskMethod=weekly&taskdescribe=&taskStatus=disable&taskEffectFrom=2010-06-01%2011:25 &startDay1=tuesday&startTime1=10:00&endDay1=friday&endTime1=12:00&taskName=week

注意:一次最多可以创建7个按周计划。

每月重复发生的停机时间计划

语法

  1. 按周计划:
    http://[host]:[port]/AppManager/[xml/json]/CreateMaintenanceTask?apikey=[apikey]&taskType=[monitor/group]&resourceid=[resourceid]&totalNumber=[1-5]&taskMethod=monthly&taskdescribe=[descrition of the downtime schedule]&taskStatus=[enable/disable]&taskEffectFrom=[yyyy-mm-dd HH:mm]&taskName=[name of task]&months=[comma seperated numbers representing months]&dateOrWeekWise=[week]&startsOn1=[First/Second/Third/Fourth/Last]&startDay1=[day]&startTime1=[HH:mm]&endAfter1=[1-7]&endTime1=[HH:mm]

  2. 按日期计划:
    http://[host]:[port]/AppManager/[xml/json]/CreateMaintenanceTask?apikey=[apikey]&taskType=[monitor/group]&resourceid=[resourceid]&totalNumber=[1-5]&taskMethod=monthly&taskdescribe=[descrition of the downtime schedule]&taskStatus=[enable/disable]&taskEffectFrom=[yyyy-mm-dd HH:mm]&taskName=[name of task]&months=[comma seperated numbers representing months]&dateOrWeekWise=[date]&startDate1=[date]&last1=[on]&startTime1=[HH:mm]&endDate1=[date]&endTime1=[HH:mm]

请求参数

API请求中涉及的参数如下所述。另外，请参阅公共请求参数列表。

字段 描述        
API Key 通过管理标签中的生成API密钥选项生成的密钥 。
taskType 要创建的任务的类型。可能的值是监视器（对于单个监视器）和业务组（对于业务组）。您可以通过将任务类型作为组来提供业务组的计划。
resourceid  必须为其创建计划的监视器或业务组的resourceid 。
totalNumber 计划表数量。
taskMethod 表示维护计划的重复频率，每月表示维护计划每周运行一次。
taskDescription 维护计划的功能描述。此参数是可选的。
taskStatus 启用或禁用。
taskEffectFrom 计划开始运行的日期和时间。
taskName 任务名称。
months 计划应运行的月份。
dateOrWeekWise 无论是每周计划还是按日期计划。
startsOn1 计划应在每月的第几周开始运行。
startDay1 计划表应该在星期几开始运行。
startTime1 计划表应开始运行的时间。
endAfter1 应该结束的天数。
endTime1 日程计划应终止的时间。
startDate1 计划开始的日期。
startTime1 计划表应开始的时间。
endDate1 计划表应结束的日期。
endTime1 计划应终止的时间。
offset 相对于GMT的小时数差异。如果提供的偏移值无效，Applications Manager将使用用户的系统时间作为偏移值。
last1 此选项使您可以按相反的顺序指定日期。这不是强制性的。如果包括该值，则应将其设置为on。

示例

  1. 按周计划:
    http://apm-8763:9090/AppManager/xml/CreateMaintenanceTask?apikey=68349d4c15833951f34d1cc7fb53f16a&taskType=monitor&resourceid=10000015&totalNumber=1&taskMethod=monthly&taskdescribe=none&taskStatus=enable&taskEffectFrom=2010-06-01%2011:25&taskName=monthlyweekwisetask&months=1,2,3,4&dateOrWeekWise=week&startsOn1=First&startDay1=Sunday&startTime1=10:00&endAfter1=2&endTime1=20:10

  2. 按日期计划:
    http://apm-8763:9090/AppManager/xml/CreateMaintenanceTask?apikey=68349d4c15833951f34d1cc7fb53f16a&taskType=monitor&resourceid=10000015&totalNumber=2&taskMethod=monthly&taskdescribe=none&taskStatus=enable&taskEffectFrom=2010-06-01%2011:25&taskName=monthlydatewisetask&months=1,2,3,4&dateOrWeekWise=date&startDate1=2&last1=&startTime1=10:00&endDate1=2&endTime1=20:10&startDate2=2&last2=on&startTime2=10:00&endDate2=1&endTime2=20:10

一次的停机计划表

语法

http://[host]:[port]/AppManager/xml/CreateMaintenanceTask?apikey=[apikey]&totalNumber=[1-5]&taskMethod=once&customTaskStartTime1=[yyyy-mm-dd HH:mm]&customTaskEndTime1=[yyyy-mm-dd HH:mm]&customTaskStartTime2=[yyyy-mm-dd HH:mm]&customTaskEndTime2=[yyyy-mm-dd HH:mm]&taskStatus=[enable/disable]&taskName=[NAME]&taskType=[monitor/group]&taskdescribe=[Description]&resourceid=[ResourceID]&totalNumber=[1-5]

请求参数

API请求中涉及的参数如下所述。另外，请参阅公共请求参数列表。

字段 描述        
API Key 通过管理标签中的生成API密钥选项生成的密钥 。
taskMethod 表示维护计划的重复频率，每周表示维护计划每周运行一次。
customTaskStartTime 计划开始运行的日期和时间
customTaskEndTime 计划停止运行的日期和时间
taskDescription 维护计划的功能描述。此参数是可选的。
offset 相对于GMT的小时数差异。如果提供的偏移值无效，Applications Manager将使用用户的系统时间作为偏移值。
taskType 要创建的任务的类型。可能的值是监视器（对于单个监视器）和业务组（对于业务组）。您可以通过将任务类型提供为业务组来为业务组配置计划 。
resourceid  必须为其创建计划的监视器或业务组的资源标识
totalNumber 计划表数量。您最多可以指定5个计划表。

示例

没有totalNumber参数：
http://app-windows:9090/AppManager/xml/CreateMaintenanceTask?apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskMethod=once &customTaskStartTime=2010-06-03%2012:46&customTaskEndTime=2010-06-05%2012:46&taskStatus=disable&taskName=once &taskType=monitor&taskdescribe=&resourceid=10000322 

包含totalNumber参数：
http://app-windows:9090/AppManager/xml/CreateMaintenanceTask?apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskMethod=once &customTaskStartTime1=2010-06-03%2012:46&customTaskEndTime1=2010-06-05%2012:46&customTaskStartTime2=2010-07-03%2012:46&customTaskEndTime2=2010-07-05%2012:46&taskStatus=disable&taskName=once &taskType=monitor&taskdescribe=once with 2 shedules&resourceid=10000322&totalNumber=2

注意:
  • 指定totalNumber参数后，必须为确认的次数定义customTaskStartTime和customTaskEndTime参数。查看上面的示例，了解有关如何定义。
  • 您可以通过执行监视器列表API请求来获取监视器的resourceid。该请求的输出包含监视器的resourceid以及其他值。