ListCloudGtmMonitorTemplates - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries health check templates based on the specified parameters.

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

alidns:ListCloudGtmMonitorTemplates

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN: Chinese. en-US (default): English.	zh-CN
PageNumber	integer	Yes	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	Yes	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20
Name	string	No	The name of the health check template. Name the template in a way that helps you distinguish between different health check protocols.	IPv4-Ping
IpVersion	string	No	The IP version of the detection points. IPv4: The destination address is an IPv4 address. IPv6: The destination address is an IPv6 address.	IPv4
Protocol	string	No	The protocol used for the health check. ping tcp http https	ping

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	75446CC1-FC9A-4595-8D96-089D73D7A63D
TotalPages	integer	The total number of pages returned.	2
TotalItems	integer	The total number of health check templates.	30
PageSize	integer	The number of entries returned on each page. Maximum value: 100. Default value: 20.	20
PageNumber	integer	The number of the returned page. Pages start from 1. Default value: 1.	1
Templates	object
Template	array<object>	A list of health check templates.
	object	The details of the health check template.
TemplateId	string	The unique ID of the health check template.	mtp-89518052425100****
CreateTime	string	The time when the health check template was created.	2024-03-23T13:09Z
CreateTimestamp	integer	The timestamp that indicates when the health check template was created.	1527690629357
UpdateTime	string	The time when the health check template was last modified.	2024-03-29T13:20Z
UpdateTimestamp	integer	The timestamp that indicates when the health check template was last modified.	1527690629357
Name	string	The name of the health check template.	IPv4-Ping
IpVersion	string	The IP version of the detection points. IPv4: The destination address is an IPv4 address. IPv6: The destination address is an IPv6 address.	IPv4
Protocol	string	The protocol used for the health check. ping tcp http https	ping
Interval	integer	The health check interval, in seconds. The default value is 60. The minimum interval of 15 seconds is available only for Ultimate Edition instances.	60
Timeout	integer	The timeout period for a health check, in milliseconds. If a response is not received within this period, the health check is considered to have timed out. Valid values: 2000 3000 5000 10000	5000
EvaluationCount	integer	The number of consecutive times a health check must fail before the system declares the service unhealthy. This helps prevent false alarms caused by network jitter. Valid values: 1 2 3	2
FailureRate	integer	The failure rate threshold. If the percentage of unhealthy detection points exceeds this threshold, the system declares the endpoint unhealthy. Valid values: 20 50 80 100	50
ExtendInfo	string	Extended information in a JSON string. The available parameters vary based on the protocol: For HTTP and HTTPS: host: The value of the Host field in the HTTP or HTTPS request header. This field specifies the website to access. The default value is the primary domain name. Modify this parameter if the destination website has specific host requirements. path: The path for the HTTP or HTTPS health check. The default path is /. code: The HTTP status code threshold. During an HTTP or HTTPS health check, the system checks the returned status code. If the code is greater than the specified value, the application service is considered unhealthy. 400: Bad Request. A web server returns a status code greater than 400 if a request contains incorrect parameters. If you set the threshold to 400, make sure to specify the correct URL path parameters. 500: Server Error. A web server returns a status code greater than 500 if a server-side exception occurs. By default, the system uses 500 as the threshold. sni: Specifies whether to enable Server Name Indication (SNI). This parameter applies only to the HTTPS protocol. SNI is an extension to the Transport Layer Security (TLS) protocol. It allows a client to specify the hostname it wants to connect to at the start of the TLS handshake. This lets the server present the correct certificate for the requested service. true: enabled false: disabled followRedirect: Specifies whether to follow 3xx redirections. true: The system follows the redirection if the status code returned by the detection point is 3xx (301, 302, 303, 307, or 308). false: The system does not follow the redirection. For ping: packetNum: The number of Internet Control Message Protocol (ICMP) packets to send for each ping health check. Valid values: 20, 50, and 100. packetLossRate: The packet loss rate threshold that triggers an alarm. The system calculates the packet loss rate for each ping health check. Packet loss rate = (Number of lost packets / Total number of sent ICMP packets) × 100%. An alarm is triggered if the packet loss rate reaches the specified threshold. Valid values: 10, 30, 40, 80, 90, and 100.	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
IspCityNodes	object
IspCityNode	array<object>	A list of detection points. For more information, see ListCloudGtmMonitorNodes.
	object	The detection point.
CountryCode	string	The country code.	001
CountryName	string	The country name.	中国
CityCode	string	The city code.	503
CityName	string	The city name.	张家口市
GroupType	string	The type of the detection point group. BGP: BGP nodes OVERSEAS: international nodes ISP: carrier nodes	BGP
GroupName	string	The name of the detection point group.	BGP节点
IspCode	string	The carrier code.	465
IspName	string	The carrier name.	阿里巴巴
Remark	string	The remarks on the health check template.	test

Examples

Success response

JSON format

{
  "RequestId": "75446CC1-FC9A-4595-8D96-089D73D7A63D",
  "TotalPages": 2,
  "TotalItems": 30,
  "PageSize": 20,
  "PageNumber": 1,
  "Templates": {
    "Template": [
      {
        "TemplateId": "mtp-89518052425100****",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690629357,
        "Name": "IPv4-Ping",
        "IpVersion": "IPv4",
        "Protocol": "ping",
        "Interval": 60,
        "Timeout": 5000,
        "EvaluationCount": 2,
        "FailureRate": 50,
        "ExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}\n",
        "IspCityNodes": {
          "IspCityNode": [
            {
              "CountryCode": "001",
              "CountryName": "中国",
              "CityCode": "503",
              "CityName": "张家口市",
              "GroupType": "BGP",
              "GroupName": "BGP节点",
              "IspCode": "465",
              "IspName": "阿里巴巴"
            }
          ]
        },
        "Remark": "test"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.