AddDnsGtmMonitor - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Creates a health check task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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:AddDnsGtmMonitor	WRITE	gtmInstance acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the values of specific response parameters. Default value: en. Valid values: en, zh, and ja.	en
AddrPoolId	string	Yes	The ID of the address pool.	pool1
ProtocolType	string	Yes	The protocol used for the health check. Valid values: HTTP HTTPS PING TCP	http
Interval	integer	Yes	The health check interval. Unit: seconds.	60
EvaluationCount	integer	Yes	The maximum number of consecutive exceptions detected. If the number of consecutive exceptions detected reaches the maximum number, the application service is deemed abnormal.	1
Timeout	integer	Yes	The health check timeout period. Unit: milliseconds.	30000
MonitorExtendInfo	string	Yes	The extended information, that is, the parameters required for the protocol. Different protocols require different parameters: HTTP or HTTPS: port: the port to check. host: the host configuration. path: the health check URL. code: the status code threshold. If the returned status code is greater than the specified threshold, the application service is deemed abnormal. failureRate: the failure rate. sni: specifies whether to enable Server Name Indication (SNI). This parameter is only required for the HTTPS protocol. Valid values: true: enables SNI. false: disables SNI. nodeType: the type of the monitored node when the address pool type is DOMAIN. Valid values: IPV4 IPV6 PING: failureRate: the failure rate. packetNum: the number of ping packets. packetLossRate: the loss rate of ping packets. nodeType: the type of the monitored node when the address pool type is DOMAIN. Valid values: IPV4 IPV6 TCP: port: the port to check. failureRate: the failure rate. nodeType: the type of the monitored node when the address pool type is DOMAIN. Valid values: IPV4 IPV6	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
IspCityNode	object []	Yes	The monitored nodes.
CityCode	string	No	The code of the city where the monitored node is deployed.	123
IspCode	string	No	The code of the Internet service provider (ISP) to which the monitored node belongs.	123

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	6856BCF6-11D6-4D7E-AC53-FD579933522B
MonitorConfigId	string	The ID of the health check configuration.	MonitorConfigId1

Examples

Sample success responses

JSONformat

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "MonitorConfigId": "MonitorConfigId1"
}

Error codes

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