AddGtmAddressPool - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Creates an address pool.

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:AddGtmAddressPool	create	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.	en
InstanceId	string	Yes	The ID of the GTM instance for which you want to create an address pool.	gtm-cn-xxxxxxx
Name	string	Yes	The name of the address pool.	Alibaba Cloud cluster
Type	string	Yes	The type of the address pool. Valid values: IP: IPv4 address DOMAIN: domain name	IP
MinAvailableAddrNum	integer	Yes	The minimum number of available addresses in the address pool.	2
MonitorStatus	string	No	Specifies whether to enable the health check. Valid values: OPEN: enables the health check. CLOSE: disables the health check. This is the default value.	OPEN
ProtocolType	string	No	The health check protocol. Valid values: HTTP HTTPS Ping TCP	HTTPS
Interval	integer	No	The health check interval. Unit: seconds. Set the value to 60.	60
EvaluationCount	integer	No	The number of consecutive failures.	2
Timeout	integer	No	The timeout period. Unit: milliseconds. Valid values: 2000, 3000, 5000, and 10000.	60
MonitorExtendInfo	string	No	The extended information. The required parameters vary based on the value of ProtocolType. When ProtocolType is set to 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 When ProtocolType is set to PING: packetNum: the number of ping packets packetLossRate: the packet loss rate failureRate: the failure rate When ProtocolType is set to TCP: port: the port that you want to check failureRate: the failure rate	{"host":"aliyun.com","port":80}
Addr	array<object>	Yes	The address pools.
	object	Yes
Value	string	No	The address in the address pool.	1.1.1.1
LbaWeight	integer	No	The weight of the address pool.	1
Mode	string	No	The mode of the address pool. Valid values: SMART: smart return ONLINE: always online OFFLINE: always offline	SMART
IspCityNode	array<object>	No	The monitored nodes.
	object	No
CityCode	string	No	The code of the city where the monitored node is deployed. For more information about specific values, see the response parameters of DescribeGtmMonitorAvailableConfig.	546
IspCode	string	No	The code of the Internet service provider (ISP) to which the monitored node belongs. For more information about specific values, see the response parameters of DescribeGtmMonitorAvailableConfig. If the value of the GroupType parameter is BGP or OVERSEAS, IspCode is optional. The default value is 465. If the value of the GroupType parameter is not BGP or OVERSEAS, IspCode is required and is used together with CityCode.	465

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
AddrPoolId	string	The ID of the address pool created.	hraf3x
MonitorConfigId	string	The ID of the health check configuration.	hraf14

Examples

Sample success responses

JSONformat

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

Error codes

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