Use DescribeHostAvailabilityList to query availability monitoring tasks - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Queries the list of availability monitoring tasks.

Operation description

This topic provides an example on how to query the list of availability monitoring tasks for the current account. The response shows that the current account has one availability monitoring task record ecs_instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeHostAvailabilityList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	No	The ID of the availability monitoring task.	123456
Ids	string	No	The IDs of multiple availability monitoring tasks. Separate multiple IDs with commas (,).	123456,345678
TaskName	string	No	The name of the availability monitoring task.	ecs_instance
PageNumber	integer	No	The page number. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Minimum value: 1. Default value: 10.	10
GroupId	integer	No	The ID of the application group.	12345

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. Note The value 200 indicates success.	200
Message	string	The error message.	The specified resource is not found.
RequestId	string	The request ID.	4A288E86-45C3-4858-9DB0-6D85B10BD92A
Total	integer	The total number of records.	1
Success	boolean	Indicates whether the operation was successful. Valid values: true: Successful. false: Failed.	true
TaskList	object
NodeTaskConfig	array<object>	The list of availability monitoring tasks.
	array<object>	The list of availability monitoring tasks.
TaskType	string	The type of the task. Valid values: PING TELNET HTTP	HTTP
GroupName	string	The name of the application group.	Group_ECS
GroupId	integer	The ID of the application group.	12345
TaskName	string	The name of the availability monitoring task.	ecs_instance
Disabled	boolean	Indicates whether the availability monitoring task is disabled. Valid values: true: The task is disabled. false: The task is enabled.	false
TaskScope	string	The scope of the availability monitoring task. Valid values: GROUP: All ECS instances in the current application group are used as detection points. GROUP_SPEC_INSTANCE: Specified ECS instances in the current application group are used as detection points.	GROUP
Id	integer	The ID of the availability monitoring task.	123456
Instances	object
Instance	array	The list of ECS instances that initiate detection.
	string	The list of ECS instances that initiate detection.	i-abcdefgh12****
TaskOption	object	The parameter options of the availability monitoring task.
HttpMethod	string	The HTTP method of the detection type. Valid values: GET POST HEAD	GET
Interval	integer	The detection frequency. Unit: seconds.	60
HttpURI	string	The URI for HTTP detection.	https://www.aliyun.com
TelnetOrPingHost	string	The domain name or address to detect.	ssh.aliyun.com
HttpResponseCharset	string	The response character set for HTTP detection.	UTF-8
HttpPostContent	string	The POST content of the HTTP detection request.	params1=paramsValue1
HttpNegative	boolean	The alert rule for matching HTTP response content. Valid values: true: An alert is triggered if the HTTP response content contains the specified alert rule. false: An alert is triggered if the HTTP response content does not contain the specified alert rule.	true
HttpKeyword	string	The keyword to match in the HTTP detection response content.	OK
AlertConfig	object	The alert rule configuration.
SilenceTime	integer	The mute period. Unit: seconds. Default value: 86400.	86400
EndTime	integer	The end time of the alert effective period. Valid values: 0 to 23. For example, if AlertConfig.StartTime is set to 0 and AlertConfig.EndTime is set to 22, the alert effective period is 00:00:00 to 22:00:00. Note If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.	22
StartTime	integer	The start time of the alert effective period. Valid values: 0 to 23. For example, if AlertConfig.StartTime is set to 0 and AlertConfig.EndTime is set to 22, the alert effective period is 00:00:00 to 22:00:00. Note If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.	0
WebHook	string	The callback URL when an alert is triggered. CloudMonitor pushes alert information to this URL by using POST requests. Only the HTTP protocol is supported.	https://www.aliyun.com
NotifyType	integer	The alert notification method. Valid values: 2: Email + DingTalk chatbot. 1: Email + DingTalk chatbot. 0: Email + DingTalk chatbot.	1
EscalationList	object
escalationList	array<object>	The conditions that trigger the alert.
	object	The conditions that trigger the alert.
Value	string	The alert threshold.	400
MetricName	string	The metric for the alert. Valid values: HttpStatus: HTTP status code. HttpLatency: HTTP response time. TelnetStatus: TELNET status code. TelnetLatency: TELNET response time. PingLostRate: PING packet loss rate.	HttpStatus
Operator	string	The comparison operator for the alert rule. Valid values: `>` `>=` `<` `<=` `=`	=
Times	string	The number of consecutive periods during which the threshold is exceeded before an alert is triggered.	3
Aggregate	string	The statistical method for the alert. The valid values vary based on the metric: Value: The value of the HTTP status code. Average: The average HTTP response time. Value: The value of the TELNET status code. TelnetLatency: The average TELNET response time. Average: The average PING packet loss rate.	Value
TargetList	object
Target	array<object>	The list of alert targets.
	object	The list of alert targets.
Id	string	The ID of the alert target.	1
Arn	string	The Alibaba Cloud Resource Name (ARN). Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows: Service: The code of the Alibaba Cloud service. Region: The region ID. Account: The Alibaba Cloud account ID. ResourceType: The resource type. ResourceId: The resource ID.	acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages
Level	string	The alert level. Valid values: INFO: Information. WARN: Warning. CRITICAL: Critical.	INFO
JsonParams	string	The JSON-formatted parameters of the alert callback.	{"key1":"value1"}

Examples

Success response

JSON format

{
  "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\"}"
              }
            ]
          }
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.