You can call this operation to query the details about an address pool of 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 DescribeGtmInstanceAddressPool

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

AddrPoolId String Yes 1234

The ID of the address pool that you want to query.

Lang String No en

The language used by the user.

Response parameters

Parameter Type Example Description
AddrCount Integer 2

The number of addresses in the address pool queried.

AddrPoolId String 1234abc

The ID of the address pool.

Addrs Array

The addresses in the address pool.

Addr

The details about an address in the address pool.

AddrId Long 123

The ID of the address.

AlertStatus String OK

Indicates whether health check was enabled for the address. Valid values:

  • OK: Normal
  • ALERT: Alert
CreateTime String 2017-12-28T13:08Z

The time when the address was created.

CreateTimeStamp Long 1527690629357

A timestamp that indicates the time when the address was created.

LbaWeight Integer 1

The weight of the address.

Mode String SMART

The mode of the address. Valid values:

  • SMART: Intelligent return
  • ONLINE: Always online
  • OFFLINE: Always offline
UpdateTime String 2017-12-28T13:08Z

The last time when the address was updated.

UpdateTimestamp Long 1527690629357

A timestamp that indicates the last time when the address was updated.

Value String 1.1.1.1

The address.

CreateTime String 2017-12-28T13:08Z

The time when the address pool was created.

CreateTimeStamp Long 1527690629357

A timestamp that indicates the time when this address pool was created.

MinAvailableAddrNum Integer 2

The minimum number of available addresses in the address pool.

MonitorConfigId String 100abc

The health check ID of the address pool.

MonitorStatus String OPEN

Indicates whether health check was enabled for the address pool. Valid values:

  • OPEN: Enabled
  • CLOSE: Disabled
  • UNCONFIGURED: Not configured
Name String Parameter

The name of the address pool.

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

The ID of the request.

Status String AVAILABLE

The availability status of the address pool. Valid values:

  • AVAILABLE: Available
  • NOT_AVAILABLE: Unavailable
Type String IP

The type of the address pool. Valid values:

  • IP: IP address
  • DOMAIN: Domain name
UpdateTime String 2017-12-28T13:08Z

The last time when the address pool was updated.

UpdateTimestamp Long 1527690629357

A timestamp that indicates the last time the address pool was updated.

Examples

Sample requests


http(s)://alidns.aliyuncs.com/? Action=DescribeGtmInstanceAddressPool
&AddrPoolId=1234
&<Common request parameters>

Sample success responses

XML format

<DescribeGtmInstanceAddressPoolResponse>
	  <RequestId>6856BCF6-11D6-4D7E-AC53-FD579933522B</RequestId>
	  <AddrPoolId>1234abc</AddrPoolId>
	  <CreateTime>2017-12-28T13:08Z</CreateTime>
	  <CreateTimestamp>1527690629357</CreateTimestamp>
	  <AddrCount>2</AddrCount>
	  <MinAvailableAddrNum>2</MinAvailableAddrNum>
	  <MonitorConfigId>100abc</MonitorConfigId>
	  <MonitorStatus>OPEN</MonitorStatus>
	  <Name>Name test 1</Name>
	  <Status>AVAILABLE</Status>
	  <Type>IP</Type>
	  <UpdateTime>2018-01-03T08:57Z</UpdateTime>
	  <UpdateTimestamp>1527690629357</UpdateTimestamp>
	  <Addrs>
		    <AddrId>123</AddrId>
		    <CreateTime>2017-12-28T13:08Z</CreateTime>
		    <CreateTimestamp>1527690629357</CreateTimestamp>
		    <UpdateTime>2018-01-03T08:57Z</UpdateTime>
		    <UpdateTimestamp>1527690629357</UpdateTimestamp>
		    <Value>1.1.1.1</Value>
		    <LbaWeight>1</LbaWeight>
		    <Mode>SMART</Mode>
		    <AlertStatus>OK</AlertStatus>
	  </Addrs>
	  <Addrs>
		    <AddrId>234</AddrId>
		    <CreateTime>2017-12-28T13:08Z</CreateTime>
		    <CreateTimestamp>1527690629357</CreateTimestamp>
		    <UpdateTime>2018-01-03T08:57Z</UpdateTime>
		    <UpdateTimestamp>1527690629357</UpdateTimestamp>
		    <Value>2.2.2.2</Value>
		    <LbaWeight>1</LbaWeight>
		    <Mode>SMART</Mode>
		    <AlertStatus>OK</AlertStatus>
	  </Addrs>
</DescribeGtmInstanceAddressPoolResponse>

JSON format

{
	"CreateTimestamp":1527690629357,
	"Addrs":[
		{
			"AddrId":123,
			"LbaWeight":1,
			"Value":"1.1.1.1",
			"CreateTimestamp":1527690629357,
			"UpdateTimestamp":1527690629357,
			"CreateTime":"2017-12-28T13:08Z",
			"UpdateTime":"2018-01-03T08:57Z",
			"AlertStatus":"OK",
			"Mode":"SMART"
		},
		{
			"AddrId":234,
			"LbaWeight":1,
			"Value":"2.2.2.2",
			"CreateTimestamp":1527690629357,
			"UpdateTimestamp":1527690629357,
			"CreateTime":"2017-12-28T13:08Z",
			"UpdateTime":"2018-01-03T08:57Z",
			"AlertStatus":"OK",
			"Mode":"SMART"
		}
	],
	"MonitorConfigId":"100abc",
	"Type":"IP",
	"UpdateTimestamp":1527690629357,
	"UpdateTime":"2018-01-03T08:57Z",
	"AddrPoolId":"1234abc",
	"MonitorStatus":"OPEN",
	"MinAvailableAddrNum":2,
	"Name": "name test 1",
	"Status":"AVAILABLE",
	"AddrCount":2,
	"RequestId":"6856BCF6-11D6-4D7E-AC53-FD579933522B",
	"CreateTime":"2017-12-28T13:08Z"
}

Error codes

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