编辑停机计划程序任务API


该API允许用户在Applications Manager中编辑停机计划表。用户可以使用以下重复类型编辑计划表:

  1. 每天
  2. 每周
  3. 每月一次
  4. 一次

您可以为业务组以及单个监视器计划维护任务。要为业务组配置计划,只需要提供 tasktype作为业务组 和 RESOURCEID 作为业务组ID

使用每日重复类型编辑停机计划表

示例请求

http://[Host]:[Port]/AppManager/xml/EditMaintenanceTask?apikey=[APIKEY]&taskMethod=[TASKMETHOD]&taskStartTime=[TASKSTARTTIME]
&taskEndTime=[TASKENDTIME]&taskStatus=[TASKSTATUS]&taskEffectFrom=[TASKEFFECTFROM]&taskName=[TASKNAME]&taskType=[TASKTYPE]
&resourceid=[RESOURCEID]&taskid=[TASKID]&overwriteAssociatedResources=[TRUE/FALSE]

请求参数

另外,请参见 常见的请求参数列表 ,该API涉及执行编辑停机任务 API请求。

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

启用已关联资源的覆盖。这意味着,如果参数的值为true,则将删除已关联的resourceid,并将新提供的ID用于任务中。可能的值为:

  1. True
  2. False

示例:

http://localhost:9000/AppManager/xml/EditMaintenanceTask?apikey=8563ac093c573d7096def3826c5bafd9&taskMethod=daily&taskStartTime=20:00&taskEndTime=21:00&taskStatus=enable&taskEffectFrom=2018-08-08%2016:48&taskName=test&taskType=monitor&resourceid=10000017&taskid=10000001&overwriteAssociatedResources=false

示例输出:

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

每周定期编辑停机计划表

示例请求

http://[Host]:[Port]/AppManager/xml/EditMaintenanceTask?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]&taskid=[TASKID]&overwriteAssociatedResources=[TRUE/FALSE]

请求参数

另外,请参见常见的请求参数列表 ,该API涉及执行EditMaintenanceTask API请求。

字段描述
totalNumber要创建的计划数。您最多可以创建7个周计划表
taskMethod表示维护计划的重复频率,每周表示维护计划每周运行一次。
taskdescribe维护计划的描述,可选值。
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
endTime[n]维护任务停止运行的时间。n的允许值为1,2,3,4,5,6和7
offset相对于GMT的小时数差异。如果提供的偏移值无效,Applications Manager将使用用户的系统时间作为偏移值。
taskType要创建的任务的类型。可能的值为 监视器(对于单个监视器)和业务组(对于业务组) 。您可以通过将tasktype提供为业务组配置计划 。
resourceid必须为其创建计划的监视器业务组的resourceid 。
overwriteAssociatedResources

启用已关联资源的覆盖。这意味着,如果参数的值为true,则将删除已关联的resourceid,并将新提供的ID用于任务中。可能的值为:

  1. True
  2. False

示例:

http://app-windows:9090/AppManager/xml/EditMaintenanceTask?apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskType=monitor
&resourceid=10000028&totalNumber=1&taskMethod=weekly&taskdescribe=&taskStatus=enable&taskEffectFrom=2010-06-01%2011:25
&startDay1=tuesday&startTime1=10:00&endDay1=friday&endTime1=12:00&taskName=week1&taskid=10000004&overwriteAssociatedResources=false

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

示例请求:

按周计划:

http://[host]:[port]/AppManager/[xml/json]/EditMaintenanceTask?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]&taskid=[downtimeschedulerid] 

按天计划:

http://[host]:[port]/AppManager/[xml/json]/EditMaintenanceTask?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]&taskid=[downtimeschedulerid]

请求参数

API请求中涉及的参数如下所述:

字段描述
API Key通过管理标签中的生成API密钥选项生成的密钥。
taskType要创建的tasktype。可能的值是监视器(对于单个监视器)和业务组(对于业务组)。您可以通过将tasktype作为组提供来为业务组配置计划。
resourceid 必须为其创建计划的监视器业务组的resourceid
totalNumber计划表数
taskMethod表示维护计划的重复频率,每月表示维护计划每周运行一次。
taskdescribe维护计划的功能描述。此参数是可选的。
taskStatus启用或禁用。
taskEffectFrom计划开始运行的日期和时间
taskName任务名称
months计划应运行的月份。
dateOrWeekWise无论是每周计划还是按日期计划。
startsOn1计划应在每月的第几周开始运行。
startDay1计划表应该在星期几开始运行。
startTime1计划表应开始运行的时间。
endAfter1应该结束的天数。
endTime1计划应终止的时间。
startDate1计划开始的日期。
startTime1计划表应开始的时间。
endDate1计划表应结束的日期号。
endTime1计划应终止的时间。

示例:

按周计划:

http://apm-8763:9090/AppManager/xml/EditMaintenanceTask?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&taskid=10000001

按天计划:

http://apm-8763:9090/AppManager/xml/EditMaintenanceTask?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&taskid=10000001

具有重复类型的一次停机时间表

示例请求:

http://[Host]:[Port]/AppManager/xml/EditMaintenanceTask?apikey=[APIKEY]&taskMethod=[TASKMETHOD]&customTaskStartTime=[CUSTOMTASKSTARTTIME]
&customTaskEndTime=[CUSTOMTASKENDTIME]&taskStatus=[TASKSTATUS]&taskName=[TASKNAME]&taskType=[TASKTYPE]
&taskdescribe=[taskdescribe]&resourceid=[RESOURCEID]&taskid=[TASKID]&overwriteAssociatedResources=[TRUE/FALSE]

请求参数

API请求中涉及的参数如下所述:

  • True
  • False
字段描述 
taskMethod表示维护计划的重复频率,每周表示维护计划每周运行一次。 
customTaskStartTime计划开始运行的日期和时间 
customTaskEndTime计划停止运行的日期和时间 
taskdescribe维护计划的功能描述。此参数是可选的。 
offset相对于GMT的小时数差异。如果提供的偏移值无效,Applications Manager将使用用户的系统时间作为偏移值。 
taskType要创建的任务的类型。可能的值为监视器 (对于单个监视器)和业务组(对于业务组) 。您可以通过将tasktype提供为业务组配置计划 。 
resourceid 必须为其创建计划的监视器业务组的resourceid 。 
overwriteAssociatedResources启用已关联资源的覆盖。这意味着,如果参数的值为true,则将删除已关联的resourceid,并将新提供的ID用于任务中。可能的值为: 

示例:

http://app-windows:9090/AppManager/xml/EditMaintenanceTask?apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskMethod=once
&customTaskStartTime=2010-06-03%2012:46&customTaskEndTime=2010-06-05%2012:46&taskStatus=enable&taskName=once1
&taskType=monitor&taskdescribe=&resourceid=10000322&taskid=10000005&overwriteAssociatedResources=false


 

注意:您可以通过执行ListMonitor API请求来获取监视器的 resourceid。该请求的输出包含监视器的resourceid以及其他值。

受到世界各地客户的喜爱

"具有广泛监控功能的Standout工具"

它允许我们跟踪关键指标,如响应时间、资源利用率、错误率和交易性能。实时监控告警会及时通知我们任何问题或异常,使我们能够立即采取行动。

审稿人角色:研究与开发

我喜欢Applications Manager,因为它可以帮助我们检测服务器和SQL数据库中存在的问题。
卡洛斯·里韦罗

Lexmark技术支持经理

受到全球6000多家企业的信任

我们的客户