Use DescribeSiteMonitorList to query site monitoring tasks - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Queries the list of site monitoring tasks by calling the DescribeSiteMonitorList operation.

Operation description

This topic provides an example of how to query the list of site monitoring tasks for the current account. The response shows that the current account has one site monitoring record named HanZhou_ECS2.

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:DescribeSiteMonitorList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	No	The ID of the site monitoring task.	a1ecd34a-8157-44d9-b060-14950837****
TaskType	string	No	The type of the site monitoring task. CloudMonitor supports the following types: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.	HTTP
Keyword	string	No	The keyword used to search for site monitoring tasks. Note Fuzzy match is supported based on the task name or task address.	site
Page	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
TaskState	string	No	The task status. Valid values: 1: Normal. 2: Disabled.	1
AgentGroup	string	No	The type of monitoring nodes used by the task. Valid values: PC: PC-based detection points. MOBILE: Mobile-based detection points. FC: Internal detection points. Valid values: PC : PC-based detection points. FC : Internal detection points. MOBILE : Mobile-based detection points.	PC

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

Response elements

Element	Type	Description	Example
	object	None.
RequestId	string	The request ID.	A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B
Success	string	Indicates whether the operation was successful. Valid values: true: Successful. false: Failed.	true
Code	string	The status code. Note 200 indicates success.	200
Message	string	The returned message.	successful
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	1
SiteMonitors	object
SiteMonitor	array<object>	The list of site monitoring tasks.
	array<object>	None.
TaskType	string	The type of the site monitoring task. CloudMonitor supports the following types: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.	TCP
UpdateTime	string	The time when the site monitoring task was last updated, in the format of YYYY-MM-DD HH:mm:ss.	2022-03-08 17:14:31
Interval	string	The monitoring interval. Unit: minutes.	1
TaskState	string	The task status. Valid values: 1: Normal. 2: Disabled.	1
CreateTime	string	The time when the task was created, in the format of YYYY-MM-DD HH:mm:ss.	2021-11-01 11:05:18
TaskName	string	The name of the site monitoring task.	New monitoring task
Address	string	The URL or IP address monitored by the task.	https://aliyun.com
TaskId	string	The ID of the site monitoring task.	f5783760-1b39-4b6b-80e8-453d962a****
OptionsJson	object	The extended options. Each monitoring type has different extended options. For more information, see CreateSiteMonitor.
password	string	The password for the SMTP, POP3, or FTP monitoring type.	123****
request_format	string	The format of the HTTP request content. Valid values: hex: hexadecimal format. txt: text format.	hex
response_content	string	The matched response content. Hexadecimal format: When the request content is a byte string that cannot be represented by visible characters, you can convert the byte string to a hexadecimal string. The conversion rule is as follows: one byte is converted to a two-character hexadecimal string. For example, 1 byte (1B) is converted to `01` in hexadecimal, and 27 bytes (27B) is converted to `1B` in hexadecimal. The binary array (in Java format) `{(byte)1, (byte)27}` is converted to `011b` or `011B` in hexadecimal. Site monitoring is case-insensitive for hexadecimal values. Enter the string `011B` in the request content and select the hexadecimal format for the request content format. Text format: Plain text refers to a string composed of visible characters.	cf0f85
failure_rate	number	The packet loss rate. Note This parameter applies only to the PING monitoring type.	0.5
time_out	integer	The timeout period. Unit: milliseconds.	3000
header	string	The HTTP request header. The format is `key1:value1`, with line breaks separating entries.	testKey:testValue
cookie	string	The cookie text for the HTTP request.	lang=en
port	integer	The port for the TCP, UDP, SMTP, or POP3 monitoring type.	80
ping_num	integer	The number of PING attempts.	20
authentication	integer	Specifies whether to enable security authentication. Valid values: 0: Enabled. 1: Disabled.	1
http_method	string	The HTTP request method. Valid values: get post head	get
match_rule	integer	Specifies whether alert rules are included. Valid values: 0: Included. 1: Not included.	0
dns_match_rule	string	The DNS matching rule. Valid values: IN_DNS: The expected aliases or IP addresses are all included in the DNS response. DNS_IN: All DNS responses are included in the expected aliases or IP addresses. EQUAL: The DNS response exactly matches the expected aliases or IP addresses. ANY: The DNS response and the expected aliases or IP addresses have an intersection.	IN_DNS
request_content	string	The HTTP request content.	cf0f85
username	string	The username for FTP, SMTP, or POP3.	testUser
response_format	string	The format of the HTTP response content. Valid values: hex: hexadecimal format. txt: text format.	hex
dns_type	string	The DNS resolution type. This parameter applies only to the DNS monitoring type. Valid values: A (default): Specifies the IP address corresponding to the hostname or domain name. CNAME: Maps multiple domain names to another domain name. NS: Specifies the DNS server that resolves the domain name. MX: Points the domain name to a mail server address. TXT: The description of the hostname or domain name. The text length is limited to 512 bytes and is typically used for SPF (Sender Policy Framework) records for anti-spam purposes. AAAA: The DNS record that resolves a domain name to an IPv6 address.	A
dns_server	string	The domain name or IP address of the specified DNS server.	192.168.XX.XX
enable_operator_dns	boolean	Specifies whether to use the carrier DNS. Valid values: true (default): Uses the carrier DNS. false: Does not use the carrier DNS. Uses the default DNS or the DNS of the specified server.	true
attempts	integer	The number of retries after a DNS failure.	3
protocol	string	The DNS protocol type. Valid values: udp (default) tcp tcp-tls	udp
proxy_protocol	boolean	Specifies whether to enable ProxyProtocol. Valid values: false (default): Disables ProxyProtocol. true: Enables ProxyProtocol.	false
acceptable_response_code	string	The acceptable status codes. Note Use assertion configurations instead.	400
isBase64Encode	string	Specifies whether to decode and store the password using Base64. Valid values: true: Decodes and stores the password using Base64. false (default): Does not decode and store the password using Base64.	false
cert_verify	boolean	Specifies whether to verify the certificate. Valid values: false (default): Ignores certificate verification. true: Verifies the certificate.	false
unfollow_redirect	boolean	Specifies whether to follow redirects when a 301 or 302 status code is returned. Valid values: true: Does not follow redirects. false (default): Follows redirects.	false
diagnosis_mtr	boolean	Specifies whether to enable automatic MTR network diagnostics after a task failure. Valid values: false (default): Disables automatic MTR network diagnostics. true: Enables automatic MTR network diagnostics.	false
diagnosis_ping	boolean	Specifies whether to enable automatic Ping network latency detection after a monitoring task failure. Valid values: false (default): Disabled. true: Enabled.	false
retry_delay	integer	The number of retries after a monitoring failure.	1
assertions	object
assertions	array<object>	The assertion configuration group.
	object	The assertion configuration group.
property	string	The parsing path for the assertion content. If the assertion type is `body_json`, the path is a `json path`. If the assertion type is `body_xml`, the path is an `xml path`.	json path
type	string	The assertion type. Valid values: response_time: Checks whether the response time meets expectations. status_code: Checks whether the HTTP response status code meets expectations. header: Checks whether a field in the response header meets expectations. body_text: Checks whether the response body content meets expectations through text string matching. body_json: Checks whether the response body content meets expectations through JSON parsing (JSON Path). body_xml: Checks whether the response body content meets expectations through XML parsing (XPath).	response_time
operator	string	The assertion comparison operator. Valid values: contains: contains. doesNotContain: does not contain. matches: matches a regular expression. doesNotMatch: does not match a regular expression. is: equals (numeric or string). isNot: does not equal. lessThan: less than. moreThan: greater than.	lessThan
target	string	The target value or string for assertion comparison.	1000
AgentGroup	string	The probe type. Valid values: PC: PC-based. MOBILE: Mobile-based.	PC

Examples

Success response

JSON format

{
  "RequestId": "A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B",
  "Success": "true",
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "SiteMonitors": {
    "SiteMonitor": [
      {
        "TaskType": "TCP",
        "UpdateTime": "2022-03-08 17:14:31",
        "Interval": "1",
        "TaskState": "1",
        "CreateTime": "2021-11-01 11:05:18",
        "TaskName": "新的探测任务",
        "Address": "https://aliyun.com",
        "TaskId": "f5783760-1b39-4b6b-80e8-453d962a****",
        "OptionsJson": {
          "password": "123****",
          "request_format": "hex",
          "response_content": "cf0f85",
          "failure_rate": 0.5,
          "time_out": 3000,
          "header": "testKey:testValue",
          "cookie": "lang=en",
          "port": 80,
          "ping_num": 20,
          "authentication": 1,
          "http_method": "get",
          "match_rule": 0,
          "dns_match_rule": "IN_DNS",
          "request_content": "cf0f85",
          "username": "testUser",
          "response_format": "hex",
          "dns_type": "A",
          "dns_server": "192.168.XX.XX",
          "enable_operator_dns": true,
          "attempts": 3,
          "protocol": "udp",
          "proxy_protocol": false,
          "acceptable_response_code": "400",
          "isBase64Encode": "false",
          "cert_verify": false,
          "unfollow_redirect": false,
          "diagnosis_mtr": false,
          "diagnosis_ping": false,
          "retry_delay": 1,
          "assertions": {
            "assertions": [
              {
                "property": "json path",
                "type": "response_time",
                "operator": "lessThan",
                "target": "1000"
              }
            ]
          }
        },
        "AgentGroup": "PC"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidQueryParameter	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	%s	%s
500	InternalError	%s
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	You are not authorized to operate the specified resource.	No permission, please use RAM to authorize
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	The number of tasks exceeds the limit
429	ThrottlingException	The request was denied due to request throttling.
409	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.