调用CreateHostAvailability接口创建可用性监控任务。

调试

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

请求参数

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

要执行的操作，取值：CreateHostAvailability。
AlertConfig.NotifyType Integer 是 2

报警通知类型。取值：

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

应用分组ID。
TaskName String 是 我的探测任务

任务名称。

取值范围：4~100个字符，支持大小写字母、数字、下划线以及汉字。
TaskType String 是 HTTP

任务类型。取值：

  • PING
  • TELNET
  • HTTP
TaskScope String 否 GROUP

任务范围。取值：

  • GROUP：表示当前应用分组内的所有ECS实例作为探测任务的探针。
  • GROUP_SPEC_INSTANCE：表示在应用分组内添加的实例作为探测任务的探针。设置该参数时，需要同时设置InstanceList.N（探测的ECS实例列表）。
TaskOption.HttpURI String 否 http://www.aliyun.com

HTTP探测类型的探测URI地址。
TaskOption.TelnetOrPingHost String 否 www.aliyun.com

探测的域名或地址。

说明 如果探测任务类型为PING或TELNET，则需要设置该参数。
TaskOption.HttpResponseCharset String 否 UTF-8

HTTP探测类型响应字符集。
TaskOption.HttpResponseMatchContent String 否 ok

匹配响应的内容。
TaskOption.HttpMethod String 否 GET

探测类型的方法。取值：

  • GET
  • POST
  • HEAD
说明 如果任务的探测类型为HTTP，则需要设置该参数。
TaskOption.HttpNegative Boolean 否 true

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

  • true：包含内容则报警
  • false：不包含内容则报警
说明 如果任务的探测类型为HTTP，则该参数生效。
AlertConfig.StartTime Integer 否 0

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

说明 如果报警不在生效时间内，则超过阈值也不会发送报警通知。
AlertConfig.EndTime Integer 否 23

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

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

通道沉默时间。单位：秒，默认：86400（1天）。
AlertConfig.WebHook String 否 http://www.aliyun.com/webhook.json

URL回调地址。
AlertConfigEscalationList.N.MetricName String 否 HttpStatus

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

  • HttpStatus：HTTP状态码
  • HttpLatency：HTTP等待时间
  • TelnetStatus：TELNET状态码
  • TelnetLatency：TELNET等待时间
  • PingLostRate：PING丢包率
AlertConfigEscalationList.N.Aggregate String 否 Value

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

  • HttpStatus：Value
  • HttpLatency：Average
  • TelnetStatus：Value
  • TelnetLatency：Average
  • PingLostRate：Average
说明 状态码类的统计方法为原始值（Value），延时时间或丢包率的统计方法为平均值（Average）。
AlertConfigEscalationList.N.Times Integer 否 3

报警重试次数。N的取值范围：1~200。
AlertConfigEscalationList.N.Operator String 否 >

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

  • >
  • >=
  • <
  • <=
  • =
AlertConfigEscalationList.N.Value String 否 90

报警阈值。
InstanceList.N RepeatList 否 i-absdfkwl321****

发起探测的ECS实例列表。

说明 该参数为空，表示该应用分组下所有的实例。

返回数据

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

请求ID。
Code String 200

状态码。

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

操作是否成功。true表示成功，false表示失败。
TaskId Long 12345

生成的任务ID。
Message String success

返回信息。

示例

请求示例

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

正常返回示例

XML 格式 

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

JSON 格式 

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

错误码

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