DescribeHostAvailabilityList - 查询可用性监控任务列表 - 云监控

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

接口说明

本文将提供一个示例，查询当前账号的可用性监控任务列表。返回结果显示，当前账号存在一条可用性监控任务记录ecs_instance。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cms:DescribeHostAvailabilityList	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Id	long	否	单个可用性监控任务 ID。	123456
Ids	string	否	多个可用性监控任务 ID。多个可用性监控任务 ID 之间用半角逗号（,）分隔。	123456,345678
TaskName	string	否	可用性监控任务名称。	ecs_instance
PageNumber	integer	否	页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页时每页显示的数据行数。起始值：1。默认值：10。	10
GroupId	long	否	应用分组 ID。	12345

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The specified resource is not found.
RequestId	string	请求 ID。	4A288E86-45C3-4858-9DB0-6D85B10BD92A
Total	integer	总记录条数。	1
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
TaskList	array<object>	可用性监控任务列表。
	object	可用性监控任务列表。
TaskType	string	任务类型。取值： PING TELNET HTTP	HTTP
GroupName	string	应用分组名称。	Group_ECS
GroupId	long	应用分组 ID。	12345
TaskName	string	可用性监控任务名称。	ecs_instance
Disabled	boolean	可用性监控任务是否禁用。取值： true：禁用。 false：启用。	false
TaskScope	string	可用性监控任务的探测范围。取值： GROUP：表示将当前应用分组内的所有 ECS 实例作为探测任务的探针。 GROUP_SPEC_INSTANCE：表示将当前应用分组内的指定 ECS 实例作为探测任务的探针。	GROUP
Id	long	可用性监控任务 ID。	123456
Instances	array	发起探测的 ECS 实例列表。
	string	发起探测的 ECS 实例列表。	i-abcdefgh12****
TaskOption	object	可用性监控任务的参数选项。
HttpMethod	string	探测类型的方法。取值： GET POST HEAD	GET
Interval	integer	探测频率。单位：秒。	60
HttpURI	string	HTTP 探测类型的探测 URI 地址。	https://www.aliyun.com
TelnetOrPingHost	string	探测的域名或地址。	ssh.aliyun.com
HttpResponseCharset	string	HTTP 探测类型的响应字符集。	UTF-8
HttpPostContent	string	HTTP 探测类型探测请求的 Post 内容。	params1=paramsValue1
HttpNegative	boolean	匹配 HTTP 响应内容的报警规则。取值： true：如果 HTTP 响应内容包含设置的报警规则，则报警。 false：如果 HTTP 响应内容不包含设置的报警规则，则报警。	true
HttpKeyword	string	HTTP 探测类型匹配响应内容。	OK
AlertConfig	object	报警规则配置。
SilenceTime	integer	通道沉默时间。单位：秒。默认值：86400。	86400
EndTime	integer	报警生效的结束时间。取值范围：0~23。例如：`AlertConfig.StartTime`为 0，`AlertConfig.EndTime`为 22，表示报警生效时间为 00:00:00 至 22:00:00。说明如果报警不在生效时间内，则超过阈值也不会发送报警通知。	22
StartTime	integer	报警生效的开始时间。取值范围：0~23。例如：`AlertConfig.StartTime`为 0，`AlertConfig.EndTime`为 22，表示报警生效时间为 00:00:00 至 22:00:00。说明如果报警不在生效时间内，则超过阈值也不会发送报警通知。	0
WebHook	string	报警发生回调时的 URL 地址。云监控会将报警信息通过 POST 请求推送到该地址，目前仅支持 HTTP 协议。	https://www.aliyun.com
NotifyType	integer	报警通知类型。取值： 2：邮件+钉钉机器人。 1：邮件+钉钉机器人。 0：邮件+钉钉机器人。	1
EscalationList	array<object>	报警触发条件。
	object	报警触发条件。
Value	string	报警阈值。	400
MetricName	string	报警监控项。取值： HttpStatus：HTTP 状态码。 HttpLatency：HTTP 等待时间。 TelnetStatus：TELNET 状态码。 TelnetLatency：TELNET 等待时间。 PingLostRate：PING 丢包率。	HttpStatus
Operator	string	报警规则比较符号。取值： `>` `>=` `<` `<=` `=`	=
Times	string	报警周期。即连续几个周期超过阈值。	3
Aggregate	string	报警统计方法。不同监控项的取值如下： Value：HTTP 状态码的值。 Average：HTTP 等待时间的平均值。 Value：TELNET 状态码的值。 TelnetLatency：TELNET 等待时间的平均值。 Average：PING 丢包率的平均值。	Value
TargetList	array<object>	报警目标列表。
	object	报警目标列表。
Id	string	报警触发目标 ID。	1
Arn	string	ARN 资源描述。格式：`arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。各字段含义如下： Service：云服务 Code。 Region：地域 ID。 Account：阿里云账号 ID。 ResourceType：资源类型。 ResourceId：资源 ID。	acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages
Level	string	报警级别。取值： INFO：信息。 WARN：警告。 CRITICAL：紧急。	INFO
JsonParams	string	报警回调的 JSON 格式参数。	{"key1":"value1"}

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "4A288E86-45C3-4858-9DB0-6D85B10BD92A",
  "Total": 1,
  "Success": true,
  "TaskList": {
    "NodeTaskConfig": [
      {
        "TaskType": "HTTP",
        "GroupName": "Group_ECS",
        "GroupId": 12345,
        "TaskName": "ecs_instance",
        "Disabled": false,
        "TaskScope": "GROUP",
        "Id": 123456,
        "Instances": {
          "Instance": [
            "i-abcdefgh12****"
          ]
        },
        "TaskOption": {
          "HttpMethod": "GET",
          "Interval": 60,
          "HttpURI": "https://www.aliyun.com",
          "TelnetOrPingHost": "ssh.aliyun.com",
          "HttpResponseCharset": "UTF-8",
          "HttpPostContent": "params1=paramsValue1",
          "HttpNegative": true,
          "HttpKeyword": "OK"
        },
        "AlertConfig": {
          "SilenceTime": 86400,
          "EndTime": 22,
          "StartTime": 0,
          "WebHook": "https://www.aliyun.com",
          "NotifyType": 1,
          "EscalationList": {
            "escalationList": [
              {
                "Value": "400",
                "MetricName": "HttpStatus",
                "Operator": "=",
                "Times": "3",
                "Aggregate": "Value"
              }
            ]
          },
          "TargetList": {
            "Target": [
              {
                "Id": "1",
                "Arn": "acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages",
                "Level": "INFO",
                "JsonParams": "{\"key1\":\"value1\"}"
              }
            ]
          }
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterInvalid	Illegal parameters.	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。
500	InternalError	The request processing has failed due to some unknown error.	-

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史