CreateCloudGtmMonitorTemplate - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Creates a health check template.

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:CreateCloudGtmMonitorTemplate	create	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
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can specify a custom value for this parameter, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	1ae05db4-10e7-11ef-b126-00163e24**22
Name	string	Yes	The name of the health check template. We recommend that you use a name that distinguishes the type of health check protocol used.	Ping-IPv4
IpVersion	string	Yes	The IP address type of health check nodes. Valid values: IPv4: You can set IpVersion to IPv4 to perform health checks on IPv4 addresses. IPv6: You can set IpVersion to IPv6 to perform health checks on IPv6 addresses.	IPv4
ExtendInfo	string	No	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: specifies 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 set path to an exact URL if you set code to 400. 500: specifies 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: specifies whether to enable Server Name Indication (SNI). 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: enables SNI. false: disables SNI. followRedirect: specifies whether to follow 3XX redirects. Valid values: true: follows 3XX redirects. You are redirected to the destination address if a 3XX status code such as 301, 302, 303, 307, or 308 is returned. false: does not follow 3XX redirects. 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>	Yes	The health check nodes. You can call the ListCloudGtmMonitorNodes operation to obtain the health check nodes.
NodeList	object	Yes	The health check node.
CityCode	string	No	The city code of the health check node.	503
IspCode	string	No	The Internet service provider (ISP) code of the health check node.	465

Response parameters

Parameter	Type	Description	Example
	object
TemplateId	string	The ID of the health check template. This ID uniquely identifies the health check template.	mtp-89518052425100**80

Examples

Sample success responses

JSONformat

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "Success": true,
  "TemplateId": "mtp-89518052425100**80"
}

Error codes

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