DescribeHostAvailabilityList - 云监控

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

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeHostAvailabilityList	要执行的操作，取值：DescribeHostAvailabilityList。
Id	Long	否	123456	单个可用性监控任务ID。
Ids	String	否	123456,345678	多个可用性监控任务ID。多个可用性监控任务ID之间用半角逗号（,）分隔。
TaskName	String	否	ecs_instance	可用性监控任务名称。
PageNumber	Integer	否	1	页码。起始值：1。默认值：1。
PageSize	Integer	否	10	分页时每页显示的数据行数。起始值：1。默认值：10。
GroupId	Long	否	12345	应用分组ID。

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

返回数据


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

示例

请求示例

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

正常返回示例

XML格式

<DescribeHostAvailabilityListResponse>
	  <RequestId>4A288E86-45C3-4858-9DB0-6D85B10BD92A</RequestId>
	  <Total>1</Total>
	  <TaskList>
		    <NodeTaskConfig>
			      <GroupName>Group_ECS</GroupName>
			      <TaskOption>
				        <HttpURI>https://aliyun.com</HttpURI>
				        <HttpMethod>GET</HttpMethod>
			      </TaskOption>
			      <AlertConfig>
				        <NotifyType>1</NotifyType>
				        <SilenceTime>86400</SilenceTime>
				        <EndTime>22</EndTime>
				        <StartTime>0</StartTime>
				        <EscalationList>
					          <escalationList>
						            <Operator>=</Operator>
						            <MetricName>HttpStatus</MetricName>
						            <Times>3</Times>
						            <Value>400</Value>
						            <Aggregate>Value</Aggregate>
					          </escalationList>
					          <escalationList>
						            <Operator>=</Operator>
						            <MetricName>HttpLatency</MetricName>
						            <Times>3</Times>
						            <Value>500</Value>
						            <Aggregate>Average</Aggregate>
					          </escalationList>
				        </EscalationList>
			      </AlertConfig>
			      <TaskName>ecs_instance</TaskName>
			      <TaskScope>GROUP</TaskScope>
			      <TaskType>HTTP</TaskType>
			      <Id>123456</Id>
			      <Disabled>false</Disabled>
			      <GroupId>12345</GroupId>
		    </NodeTaskConfig>
	  </TaskList>
	  <Code>200</Code>
	  <Success>true</Success>
</DescribeHostAvailabilityListResponse>

JSON格式

{
	"RequestId": "4A288E86-45C3-4858-9DB0-6D85B10BD92A",
	"Total": 1,
	"TaskList": {
		"NodeTaskConfig": [
			{
				"GroupName": "Group_ECS",
				"TaskOption": {
					"HttpURI": "https://aliyun.com",
					"HttpMethod": "GET"
				},
				"AlertConfig": {
					"NotifyType": 1,
					"SilenceTime": 86400,
					"EndTime": 22,
					"StartTime": 0,
					"EscalationList": {
						"escalationList": [
							{
								"Operator": "=",
								"MetricName": "HttpStatus",
								"Times": 3,
								"Value": "400",
								"Aggregate": "Value"
							},
							{
								"Operator": "=",
								"MetricName": "HttpLatency",
								"Times": 3,
								"Value": "500",
								"Aggregate": "Average"
							}
						]
					}
				},
				"TaskName": "ecs_instance",
				"TaskScope": "GROUP",
				"TaskType": "HTTP",
				"Id": 123456,
				"Disabled": false,
				"GroupId": 12345
			}
		]
	},
	"Code": 200,
	"Success": true
}

错误码


HttpCode	错误码	错误信息	描述
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。

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