AddGtmMonitor - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Creates a health check task.

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:
- 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:AddGtmMonitor	create	gtminstance acs:alidns::{#accountId}:gtminstance/{#gtminstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language.	en
AddrPoolId	string	Yes	The ID of the address pool.	xxxx
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. Set the value to 60.	60
EvaluationCount	integer	Yes	The number of consecutive failures.	3
Timeout	integer	Yes	The health check timeout period. Unit: milliseconds. Valid values: 2000, 3000, 5000, and 10000.	3000
MonitorExtendInfo	string	Yes	The extended information. The required parameters vary based on the health check protocol. HTTP or HTTPS port: the port that you want to check failureRate: the failure rate code: the return code. The health check result is deemed abnormal if the returned value is greater than the specified value. Valid values: 400 and 500. host: the host settings path: the URL path PING packetNum: the number of ping packets packetLossRate: the packet loss rate failureRate: the failure rate TCP port: the port that you want to check failureRate: the failure rate	{\"code\":200,\"path\":\"/index.htm\",\"host\":\"aliyun.com\"}
IspCityNode	array<object>	Yes	The nodes for monitoring.
	object	Yes
CityCode	string	No	The city code. Specify the parameter according to the value of CityCode returned by the DescribeGtmMonitorAvailableConfig operation.	503
IspCode	string	No	The Internet service provider (ISP) node. Specify the parameter according to the value of IspCode returned by the DescribeGtmMonitorAvailableConfig operation. If the return value of GroupType for the DescribeGtmMonitorAvailableConfig operation is BGP or Overseas, IspCode is not required and is set to 465 by default. If the return value of GroupType for the DescribeGtmMonitorAvailableConfig operation is not BGP or Overseas, IspCode is required. When IspCode is specified, CityCode is required.	465

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.	1234abc

Examples

Sample success responses

JSONformat

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

Error codes

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