You can call this operation to create an address pool for a Global Traffic Manager (GTM) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AddGtmAddressPool

The operation that you want to perform. Set the value to AddGtmAddressPool.

InstanceId String Yes gtm-cn-xxxxxxx

The ID of the GTM instance for which you want to create an address pool.

MinAvailableAddrNum Integer Yes 2

The minimum number of available addresses in the address pool.

Name String Yes Alibaba Cloud cluster

The name of the address pool that you want to create.

Type String Yes IP

The type of the address pool that you want to create. Valid values:

  • IP: IPv4 address
  • DOMAIN: Domain name
Addr.N.LbaWeight Integer No 1

The weight of the address pool that you want to create.

Addr.N.Mode String No SMART

The mode of the address pool that you want to create. Valid values:

  • SMART: Intelligent return
  • ONLINE: Always online
  • OFFLINE: Always offline
Addr.N.Value String No 1.1.1.1

The addresses in the address pool that you want to create.

EvaluationCount Integer No 2

The number of consecutive times of failed health check attempts.

Interval Integer No 60

The health check interval.

IspCityNode.N.CityCode String No 546

The city code of the monitored node. For more information about specific values, see the response parameters of DescribeGtmMonitorAvailableConfig.

IspCityNode.N.IspCode String No 465

The Internet provider service (ISP) code of the monitored node. For more information about specific values, see the response parameters of DescribeGtmMonitorAvailableConfig.

Lang String No en

The language used by the user.

MonitorExtendInfo String No {"host":"aliyun.com","port":80}

The extended information. Valid values:

  • port: Check port
  • host: Host settings
  • path: The URL path
  • code: Return code greater than the specified value
  • failureRate: Failure rate
  • packetNum: The number of ping packets
  • packetLossRate: The loss rate of ping packets
MonitorStatus String No OPEN

Specifies whether health check is enabled. Valid values:

  • OPEN: Enabled
  • CLOSE(Default): Disabled
ProtocolType String No HTTPS

The protocol that you want to use for health check. Valid values:

  • HTTP
  • HTTPS
  • PING
  • TCP
Timeout Integer No 60

The health check timeout period.

Response parameters

Parameter Type Example Description
AddrPoolId String hraf3x

The ID of the address pool created.

MonitorConfigId String hraf14

The health check ID of the address pool created.

RequestId String 6856BCF6-11D6-4D7E-AC53-FD579933522B

The ID of the request.

Examples

Sample requests


http(s)://alidns.aliyuncs.com/? Action=AddGtmAddressPool
&InstanceId=gtm-cn-xxxxxxx
&MinAvailableAddrNum=2
&Name=Alibaba Cloud cluster
&Type=IP
&<Common request parameters>

Sample success responses

XML format

<AddGtmAddressPoolResponse>
      <RequestId>6856BCF6-11D6-4D7E-AC53-FD579933522B</RequestId>
	  <AddrPoolId>hraf3x</AddrPoolId>
	  <MonitorConfigId>hraf14</MonitorConfigId>
</AddGtmAddressPoolResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.