ListCloudGtmMonitorTemplates - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries a list of health check templates based on specified parameters.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:ListCloudGtmMonitorTemplates	list	All Resources ``	none	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	en-US
PageNumber	integer	Yes	Current page number, starting from 1, default is 1.	1
PageSize	integer	Yes	The number of rows per page when paginating queries, with a maximum value of 100 and a default of 20.	20
Name	string	No	The name of the health check probe template, which is recommended to be distinguishable for configuration personnel to differentiate and remember, ideally indicating the health check protocol.	IPv4-Ping
IpVersion	string	No	The IP address type of health check nodes. Valid values: IPv4: applicable when health checks are performed on IPv4 addresses. IPv6: applicable when health checks are performed on IPv6 addresses.	IPv4
Protocol	string	No	Protocol types for initiating probes to the target IP address: ping tcp http https	ping

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Unique request identification code.	75446CC1-FC9A-4595-8D96-089D73D7A63D
TotalPages	integer	Total number of pages after data pagination.	2
TotalItems	integer	Total number of health check template entries retrieved.	30
PageSize	integer	The number of rows per page when paginating queries, with a maximum value of 100 and a default of 20.	20
PageNumber	integer	Current page number, starting from 1, default is 1.	1
Templates	array<object>	The health check templates.
Template	object	The health check template.
TemplateId	string	The ID of the health check template. This ID uniquely identifies the health check template.	mtp-89518052425100**80
CreateTime	string	Health check template creation time.	2024-03-23T13:09Z
CreateTimestamp	long	Health check template creation time (timestamp).	1527690629357
UpdateTime	string	Last modification time of the health check template.	2024-03-29T13:20Z
UpdateTimestamp	long	Health check template configuration modification time (timestamp).	1527690629357
Name	string	The name of the health check probe template, generally for the convenience of configuration personnel to distinguish and remember.	IPv4-Ping
IpVersion	string	The IP address type of health check nodes. Valid values: IPv4: applicable when health checks are performed on IPv4 addresses. IPv6: applicable when health checks are performed on IPv6 addresses.	IPv4
Protocol	string	Protocol types for initiating probes to the target IP address: ping tcp http https	ping
Interval	integer	The time interval between each check (in seconds), with a default of probing once every minute. The minimum supported health check interval is 15 seconds, available for flagship edition instances.	60
Timeout	integer	Probe timeout (in milliseconds), data packets not returned within the timeout period are deemed as health check timeouts: 2000 3000 5000 10000	5000
EvaluationCount	integer	The number of retries. The system will only judge the application service as abnormal after consecutive monitoring failures to prevent inaccurate monitoring results due to momentary network fluctuations or other reasons. Available retry options are: 1 - 2 - 3	2
FailureRate	integer	Percentage of selected node probe failures (%), that is, the percentage of unhealthy check points among total probe points. When the failure ratio exceeds the set threshold, the service address is judged as abnormal. The available failure ratio thresholds are: 20 50 80 100	50
ExtendInfo	string	The extended information. The value of this parameter is a JSON string. The required parameters vary based on the health check protocol. HTTP or HTTPS: host: the Host field of an HTTP or HTTPS request header during an HTTP or HTTPS health check. The parameter value indicates the HTTP website that you want to visit. By default, the value is the primary domain name. You can change the value based on your business requirements. path: the URL for HTTP or HTTPS health checks. Default value: /. code: the alert threshold. During an HTTP or HTTPS health check, the system checks whether a web server functions as expected based on the status code that is returned from the web server. If the returned status code is greater than the specified threshold, the corresponding application service address is deemed abnormal. Valid values: 400: indicates an invalid request. If an HTTP or HTTPS request contains invalid request parameters, a web server returns a status code that is greater than 400. You must specify an exact URL for path if you set code to 400. 500: indicates a server error. If some exceptions occur on a web server, the web server returns a status code that is greater than 500. This value is used by default. sni: indicates whether Server Name Indication (SNI) is enabled. This parameter is used only when the health check protocol is HTTPS. SNI is an extension to the Transport Layer Security (TLS) protocol, which allows a client to specify the host to be connected when the client sends a TLS handshake request. TLS handshakes occur before any data of HTTP requests is sent. Therefore, SNI enables servers to identify the services that clients are attempting to access before certificates are sent. This allows the servers to present correct certificates to the clients. Valid values: true: SNI is enabled. false: SNI is disabled. followRedirect: indicates whether 3XX redirects are followed. Valid values: true: 3XX redirects are followed. You are redirected to the destination address if a 3XX status code such as 301, 302, 303, 307, or 308 is returned. false: 3XX redirects are not followed. ping: packetNum: the total number of Internet Control Message Protocol (ICMP) packets that are sent to the address for each ping-based health check. Valid values: 20, 50, and 100. packetLossRate: the ICMP packet loss rate for each ping-based health check. The packet loss rate in a health check can be calculated by using the following formula: Packet loss rate in a health check = (Number of lost packets/Total number of sent ICMP packets) × 100%. If the packet loss rate reaches the threshold, an alert is triggered. Valid values: 10, 30, 40, 80, 90, and 100.	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
IspCityNodes	array<object>	The health check nodes. You can call the ListCloudGtmMonitorNodes operation to obtain the health check nodes.
IspCityNode	object	Probe node.
CountryCode	string	Country code.	629
CountryName	string	Country name.	China
CityCode	string	City code.	738
CityName	string	City name.	Beijing
GroupType	string	Probe node group types: BGP: BGP nodes OVERSEAS: International nodes ISP: Carrier nodes	BGP
GroupName	string	Probe node group name.	BGP Nodes
IspCode	string	Operator code.	465
IspName	string	Operator name.	Alibaba
Remark	string	Remarks for the health check template.	test

Examples

Sample success responses

JSONformat

{
  "RequestId": "75446CC1-FC9A-4595-8D96-089D73D7A63D",
  "TotalPages": 2,
  "TotalItems": 30,
  "PageSize": 20,
  "PageNumber": 1,
  "Templates": {
    "Template": [
      {
        "TemplateId": "mtp-89518052425100**80",
        "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": "629",
              "CountryName": "China",
              "CityCode": "738",
              "CityName": "Beijing",
              "GroupType": "BGP",
              "GroupName": "BGP Nodes",
              "IspCode": "465",
              "IspName": "Alibaba"
            }
          ]
        },
        "Remark": "test"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.