DescribeCloudGtmMonitorTemplate - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves the configuration of a specified health check template.

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

get

*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
TemplateId	string	Yes	The unique ID of the health check template.	mtp-89518052425100****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF
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 UNIX 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 UNIX timestamp that indicates when the health check template was last modified.	1527690629357
Name	string	The name of the health check template. To easily identify the template, specify a name that indicates the health check protocol.	Ping-IPv4
IpVersion	string	The IP address type of the detection points: IPv4: The target address is an IPv4 address. IPv6: The target address is an IPv6 address.	IPv4
Protocol	string	The protocol used to probe the target IP address: ping tcp http https	ping
Interval	integer	The interval between health checks in seconds. The default value is 60. The minimum interval is 15 seconds. This feature is available only for Ultimate Edition instances.	60
Timeout	integer	The health check timeout period in milliseconds. If a packet is not returned within the specified timeout period, the health check fails. Valid values: 2000 3000 5000 10000	5000
EvaluationCount	integer	The number of consecutive times that a health check must fail before the application service is declared abnormal. This prevents false alarms caused by transient issues such as network jitter. Valid values: 1 2 3	2
FailureRate	integer	The percentage of failed detection points. If the percentage of failed detection points exceeds this value, the endpoint is declared abnormal. Valid values: 20 50 80 100	50
ExtendInfo	string	The extended information in a JSON string. The parameters vary based on the protocol. For HTTP and HTTPS: host: The Host field in the HTTP or HTTPS request header. This field identifies the website that you want to access. The default value is the primary domain name. If the target website has specific host requirements, modify this parameter. path: The URL path for HTTP or HTTPS health checks. The default value is /. code: The system determines whether the web server is working as expected based on the return code. If the return code is greater than the specified threshold, the application service is considered abnormal. 400: Bad Request. If an HTTP or HTTPS request contains incorrect parameters, the web server returns a code greater than 400. If you set the threshold to 400, specify the exact URL path. 500: Server Error. If an exception occurs on the web server, it returns a code greater than 500. The default threshold is 500. sni: Specifies whether to enable Server Name Indication (SNI). This parameter is used only for the HTTPS protocol. SNI is a Transport Layer Security (TLS) extension that allows a client to specify the hostname it wants to connect to at the start of the TLS handshake. This allows the server to present the correct certificate for that hostname. true: Enable SNI. false: Disable SNI. followRedirect: Specifies whether to follow 3xx redirections. true: If the status code returned by the detection point is 3xx (301, 302, 303, 307, or 308), the system follows the redirection. false: The system does not follow the redirection. For ping: packetNum: The number of ICMP packets to send for each ping health check. Valid values: 20, 50, and 100. packetLossRate: The packet loss rate threshold. For each ping health check, the system calculates the packet loss rate. If the packet loss rate reaches the threshold, an alert is triggered. Packet loss rate = (Number of lost packets / Total number of sent ICMP packets) × 100%. Valid values for the packet loss rate are 10, 30, 40, 80, 90, and 100.	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
IspCityNodes	object
IspCityNode	array<object>	The list of detection points. For more information, call the ListCloudGtmMonitorNodes operation.
	object	A 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 group type of the detection points: BGP: Border Gateway Protocol (BGP) nodes OVERSEAS: Nodes outside mainland China 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": "6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF",
  "TemplateId": "mtp-89518052425100****",
  "CreateTime": "2024-03-23T13:09Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-29T13:20Z",
  "UpdateTimestamp": 1527690629357,
  "Name": "Ping-IPv4",
  "IpVersion": "IPv4",
  "Protocol": "ping",
  "Interval": 60,
  "Timeout": 5000,
  "EvaluationCount": 2,
  "FailureRate": 50,
  "ExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}",
  "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.