SearchCloudGtmMonitorTemplates - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Searches for health check templates.

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

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 current 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 for a paged query. The maximum value is 100. The default value is 20.	20
Name	string	No	The name of the health check template. A fuzzy search is performed based on the keyword that you enter.	IPv4-Ping
IpVersion	string	No	The IP version of the detection points. An exact search is performed. Valid values: IPv4: This version is applicable when the target address is an IPv4 address. IPv6: This version is applicable when the target address is an IPv6 address.	IPv4
Protocol	string	No	The protocol used for detection. An exact search is performed. Valid values: ping tcp http https	ping

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of health check templates that are found.	1
PageSize	integer	The number of entries returned on each page. The maximum value is 100. The default value is 20.	20
PageNumber	integer	The current page number. The value starts from 1. The default value is 1.	1
Templates	object
Template	array<object>	A list of health check templates.
	object	The information about the health check template.
TemplateId	string	The ID of the health check template. The ID uniquely identifies a health check template.	mtp-89518052425100**80
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. For easy identification, specify a name that indicates the health check protocol.	IPv4-Ping
IpVersion	string	The IP version of the detection points. Valid values: IPv4: This version is applicable when the target address is an IPv4 address. IPv6: This version is applicable when the target address is an IPv6 address.	IPv4
Protocol	string	The protocol used to probe the target IP address. Valid values: ping tcp http https	ping
Interval	integer	The interval between two consecutive health checks. Unit: seconds. The default interval is 1 minute. The minimum interval is 15 seconds. This feature is available only for Ultimate Edition instances.	60
Timeout	integer	The timeout period for a health check. Unit: milliseconds. If a packet is not returned within the timeout period, the health check is considered to have timed out. Valid values: 2000 3000 5000 10000	5000
EvaluationCount	integer	The number of retries. The system considers the application service abnormal only after the number of consecutive abnormal health checks reaches the specified value. This prevents monitoring accuracy from being affected by factors such as transient network jitter. Valid values: 1 2 3	2
FailureRate	integer	The failure rate of the selected detection points. This is the percentage of abnormal detection points in all detection points. If the failure rate exceeds the specified threshold, the endpoint is considered abnormal. Valid thresholds for the failure rate are: 20 50 80 100	50
ExtendInfo	string	The extended information in a JSON string. The following parameters are required for different protocols: http(s): host: When you perform an HTTP or HTTPS health check, this parameter specifies the Host field in the HTTP or HTTPS request header. This identifies the target HTTP website. The default value is the primary domain name. If the host of the target website has special requirements, modify this parameter as needed. path: The path for the HTTP or HTTPS health check. The system fills in "/" by default. code: When you perform an HTTP or HTTPS health check, the system determines whether the web server is working as expected based on the return code from the web server. If the return code is greater than the alert threshold, the system considers the application service abnormal. 400: Bad Request. If an HTTP or HTTPS request contains invalid parameters, the web server returns a return code greater than 400. If you set the check content to "Abnormal code greater than 400", specify the exact URL path in the URL path parameter. 500: Server Error. If an exception occurs on the web server, the server returns a return code greater than 500. The system uses a return code greater than 500 as the alert threshold by default. sni: Specifies whether to enable Server Name Indication (SNI). This parameter is used only for the HTTPS protocol. SNI is an extension to the TLS protocol. It allows a client to specify the hostname that it wants to connect to when initiating a TLS handshake. Because the TLS handshake occurs before any data of an HTTP request is sent, SNI allows the server to know the service that the client is trying to access before the server sends a certificate. This allows the server to select the correct certificate to present to the client. true: Enable SNI. false: Disable SNI. followRedirect: Specifies whether to follow 3xx redirections. true: Follows the redirection if the detection point receives a 3xx status code (301, 302, 303, 307, or 308). false: Does not follow the redirection. 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 that indicates an abnormal status. For each ping health check, the system calculates the packet loss rate based on the sent ICMP packets. Packet loss rate = (Number of lost packets / Total number of sent ICMP packets) × 100%. An alert is triggered if the packet loss rate reaches the specified threshold. Valid values for the packet loss rate: 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.
	object	The information about 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. Valid values: 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": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "TotalPages": 1,
  "TotalItems": 1,
  "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\\\"}",
        "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.