调用DescribeHostAvailabilityList接口查询可用性监控任务列表。

调试

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

请求参数

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

要执行的操作,取值:DescribeHostAvailabilityList。

Id Long 123456

任务ID。

TaskName String 我的探测

任务名称。

PageNumber Integer 1

页码。

PageSize Integer 10

每页记录条数。

GroupId Long 12345

应用分组ID。

返回数据

名称 类型 示例值 描述
RequestId String CE26797C-1094-47E6-B651-73AA888F5873

请求ID。

Code String 200

状态码。

说明 200表示成功。
Success Boolean true

操作是否成功。true表示成功,false表示失败。

TaskList Array

任务列表。

NodeTaskConfig
AlertConfig Struct

报警规则配置。

EndTime Integer 23

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

EscalationList Array

报警的触发条件。

escalationList
Aggregate String Value

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

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

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

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

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

  • >
  • >=
  • <
  • <=
  • =
Times String 2

周期数。即连续几个周期超过阈值。

Value String 99

监控阈值。

NotifyType Integer 1

报警通知类型。取值:

0:邮件+钉钉机器人

SilenceTime Integer 86400

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

StartTime Integer 0

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

WebHook String http://www.aliyun.com

URL回调地址。

Disabled Boolean false

是否禁用。

GroupId Long 12345

应用分组ID。

GroupName String 应用组名

应用分组名称。

Id Long 123

任务ID。

Instances List i-abcdefgh12****

发起探测的ECS实例列表。

TaskName String 我的内网探测

任务名称。

TaskOption Struct

任务的参数选项。

HttpKeyword String ok

HTTP探测类型匹配响应内容。

HttpMethod String GET

探测类型的方法。取值:

  • GET
  • POST
  • HEAD
HttpNegative Boolean true

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

  • true:包含内容则报警
  • false:不包含内容则报警
HttpResponseCharset String UTF-8

HTTP探测类型响应字符集。

HttpURI String http://www.aliyun.com

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

TelnetOrPingHost String ssh.aliyun.com

探测的域名或地址。

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

任务的范围。取值:

  • INSTANCE:任务作用在指定(1个或多个)实例上。
  • GROUP:任务作用在整个组上(组内所有实例)。
  • GROUP_SPEC_INSTANCEUP_SPEC_INSTANCE:任务作用在组内指定(1个或多个)实例上 。
TaskType String HTTP

任务类型。取值:

  • PING
  • TELNET
  • HTTP
Total Integer 12

总记录条数。

Message String success

返回信息。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeHostAvailabilityList
&<公共请求参数>

正常返回示例

XML 格式

<DescribeHostAvailabilityListResponse>
   <TaskList>
            <NodeTaskConfig>
                  <GroupName>我的应用组</GroupName>
                  <TaskOption>
                        <HttpMethod>GET</HttpMethod>
                        <HttpURI>http://www.aliyun.com</HttpURI>
                  </TaskOption>
                  <Disabled>false</Disabled>
                  <Instances>
                        <Instance>i-a2d5q7pm3f123y***</Instance>
                        <Instance>i-a2d5q7pm3f123x***</Instance>
                  </Instances>
                  <Id>123345</Id>
                  <AlertConfig>
                        <EscalationList>
                              <escalationList>
                                    <Value>400</Value>
                                    <MetricName>HttpStatus</MetricName>
                                    <Operator>&gt;</Operator>
                                    <Times>3</Times>
                                    <Aggregate>Value</Aggregate>
                              </escalationList>
                              <escalationList>
                                    <Value>500</Value>
                                    <MetricName>HttpLatency</MetricName>
                                    <Operator>&gt;</Operator>
                                    <Times>3</Times>
                                    <Aggregate>Average</Aggregate>
                              </escalationList>
                        </EscalationList>
                        <SilenceTime>86400</SilenceTime>
                        <NotifyType>1</NotifyType>
                        <EndTime>24</EndTime>
                        <StartTime>0</StartTime>
                  </AlertConfig>
                  <TaskType>HTTP</TaskType>
                  <TaskName>我的内网探测任务</TaskName>
                  <GroupId>12345</GroupId>
                  <TaskScope>GROUP</TaskScope>
            </NodeTaskConfig>
      </TaskList>
      <RequestId>CE26797C-1094-47E6-B651-73AA888F5873</RequestId>
      <Success>true</Success>
      <Code>200</Code>
      <Total>3</Total>
</DescribeHostAvailabilityListResponse>

JSON 格式

{
    "TaskList": {
        "NodeTaskConfig": [
            {
                "GroupName": "我的应用组",
                "TaskOption": {
                    "HttpMethod": "GET",
                    "HttpURI": "http://www.aliyun.com"
                },
                "Disabled": false,
                "Instances": {
                    "Instance": [
                        "i-a2d5q7pm3f123y***",
                        "i-a2d5q7pm3f123x***"
                    ]
                },
                "Id": 123345,
                "AlertConfig": {
                    "EscalationList": {
                        "escalationList": [
                            {
                                "Value": "400",
                                "MetricName": "HttpStatus",
                                "Operator": ">",
                                "Times": 3,
                                "Aggregate": "Value"
                            },
                            {
                                "Value": "500",
                                "MetricName": "HttpLatency",
                                "Operator": ">",
                                "Times": 3,
                                "Aggregate": "Average"
                            }
                        ]
                    },
                    "SilenceTime": 86400,
                    "NotifyType": 1,
                    "EndTime": 24,
                    "StartTime": 0
                },
                "TaskType": "HTTP",
                "TaskName": "我的内网探测任务",
                "GroupId": 12345,
                "TaskScope": "GROUP"
            }
        ]
    },
    "RequestId": "CE26797C-1094-47E6-B651-73AA888F5873",
    "Success": true,
    "Code": 200,
    "Total": 3
}

错误码

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