调用ModifyHostAvailability接口修改可用性监控任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyHostAvailability

系统规定参数。取值:ModifyHostAvailability。

AlertConfig.NotifyType Integer 2

报警通知类型。取值:

  • 2:电话+短信+邮件+钉钉机器人
  • 1:短信+邮件+钉钉机器人
  • 0:邮件+钉钉机器人
GroupId Long 12345

应用分组ID。

Id Long 12345

任务ID。

TaskName String 我的探测任务

任务名称。

AlertConfig.EndTime Integer 23

报警生效的结束时间,取值范围为0~23。

说明 如果报警不在生效期间内,超过阈值也不会发送报警通知。
AlertConfig.SilenceTime Integer 86400

通道沉默时间,单位为秒,默认为86400(1天)。

AlertConfig.StartTime Integer 0

报警生效的起始时间,取值范围为0~23。

说明 如果报警不在生效期间内,超过阈值也不会发送报警通知。
AlertConfig.WebHook String http://www.aliyun.com/webhook.json

URL回调地址。

AlertConfigEscalationList.N.Aggregate String Value

报警统计方法,不同的监控项的统计方法取值如下:

  • HttpStatus:Value
  • HttpLatency:Average
  • TelnetStatus:Value
  • TelnetLatency:Average
  • PingLostRate:Average
说明 状态码类的统计方法为原始值(Value),延时时间或丢包率的统计方法为平均值(Average)。
AlertConfigEscalationList.N.MetricName String HttpStatus

需要报警的监控项。取值:

  • HttpStatus:HTTP状态码
  • HttpLatency:HTTP等待时间
  • TelnetStatus:TELNET状态码
  • TelnetLatency:TELNET等待时间
  • PingLostRate:PING丢包率
AlertConfigEscalationList.N.Operator String >

报警规则比较符号。取值:

  • >
  • >=
  • <
  • <=
  • =
AlertConfigEscalationList.N.Times Integer 3

报警重试次数。N的取值范围为1~200。

AlertConfigEscalationList.N.Value String 3

报警阈值。

InstanceList.N RepeatList i-absdfkwl3212346

发起探测的ECS实例列表。

说明 此参数为空表示该应用组下所有的机器。
TaskOption.HttpMethod String GET

探测类型的方法。取值:

  • GET
  • POST
  • HEAD
说明 如果任务的探测类型为HTTP,需要传入此参数。
TaskOption.HttpNegative Boolean true

匹配HTTP响应内容的规则。取值:

  • true:包含内容则报警
  • false:不包含内容则报警
说明 如果任务的探测类型为HTTP,则此参数生效。
TaskOption.HttpResponseCharset String UTF-8

HTTP探测类型响应字符集。

TaskOption.HttpResponseMatchContent String ok

匹配响应的内容。

TaskOption.HttpURI String http://www.aliyun.com

HTTP探测类型的探测URI地址。

TaskOption.TelnetOrPingHost String www.aliyun.com

探测的域名或地址。

说明 如果探测任务类型是PINGTELNET,需要传入此参数。
TaskScope String GROUP

任务范围。取值:

  • GROUP:表示当前应用组内的所有ECS作为探测任务的探针。
  • INSTANCE:表示从组内指定的实例作为探测任务的探针。

返回数据

名称 类型 示例值 描述
RequestId String ACBDBB40-DFB6-4F4C-8957-51FFB233969C

请求ID。

Message String success

错误信息。

Code String 200

状态码。

说明 状态码为200表示成功。
Success Boolean true

请求是否成功。

示例

请求示例


http(s)://[Endpoint]/?Action=ModifyHostAvailability
&AlertConfig.NotifyType=2
&GroupId=12345
&Id=12345
&TaskName=我的探测任务
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>ACBDBB40-DFB6-4F4C-8957-51FFB233969C</RequestId>
<Success>true</Success>
<Code>200</Code>

JSON 格式

{
	"RequestId":"ACBDBB40-DFB6-4F4C-8957-51FFB233969C",
	"Success":true,
	"Code":200
}

错误码

访问错误中心查看更多错误码。