You can call this operation to query the address pools 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 DescribeGtmInstanceAddressPools

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

InstanceId String Yes gtmtest

The ID of the GTM instance that you want to query.
Lang String No en

The language used by the user.
PageNumber Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

PageSize Integer No 20

The number of entries to return per page. Maximum value: 100. Default value: 20.

Response parameters

Parameter Type Example Description
AddrPools Array

The returned list of address pools of the GTM instance.
AddrPool

The details about an address pool.
AddrCount Integer 2

The number of addresses in the address pool.
AddrPoolId String 1234abc

The ID of the address pool.
CreateTime String 2017-12-28T13:08Z

The time when this 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.
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.
PageNumber Integer 1

The number of the page returned.
PageSize Integer 20

The number of entries returned per page.
RequestId String 6856BCF6-11D6-4D7E-AC53-FD579933522B

The ID of the request.
TotalItems Integer 2

The total number of entries returned on all pages.
TotalPages Integer 1

The total number of pages returned.

Examples

Sample requests


http(s)://alidns.aliyuncs.com/? Action=DescribeGtmInstanceAddressPools
&InstanceId=gtmtest
&<Common request parameters>

Sample success responses

XML format 

<DescribeGtmInstanceAddressPoolsResponse>
  <PageNumber>1</PageNumber>
	  <PageSize>20</PageSize>
	  <RequestId>6856BCF6-11D6-4D7E-AC53-FD579933522B</RequestId>
	  <TotalItems>2</TotalItems>
	  <TotalPages>1</TotalPages>
	  <AddrPools>
		    <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>
	  </AddrPools>
	  <AddrPools>
		    <AddrPoolId>2345abc</AddrPoolId>
		    <CreateTime>2017-12-28T13:08Z</CreateTime>
		    <CreateTimestamp>1527690629357</CreateTimestamp>
		    <AddrCount>2</AddrCount>
		    <MinAvailableAddrNum>2</MinAvailableAddrNum>
		    <MonitorConfigId>101abc</MonitorConfigId>
		    <MonitorStatus>OPEN</MonitorStatus>
		    <Name>Name test 2</Name>
		    <Status>AVAILABLE</Status>
		    <Type>IP</Type>
		    <UpdateTime>2018-01-03T08:57Z</UpdateTime>
		    <UpdateTimestamp>1527690629357</UpdateTimestamp>
	  </AddrPools>
</DescribeGtmInstanceAddressPoolsResponse>

JSON format 

{
	"PageNumber":1,
	"PageSize":20,
	"RequestId":"6856BCF6-11D6-4D7E-AC53-FD579933522B",
	"TotalItems":2,
	"TotalPages":1,
	"AddrPools":[
		{
			"Name":"Name test 1",
			"Status":"AVAILABLE",
			"CreateTimestamp":1527690629357,
			"AddrCount":2,
			"MonitorConfigId":"100abc",
			"Type":"IP",
			"UpdateTimestamp":1527690629357,
			"CreateTime":"2017-12-28T13:08Z",
			"UpdateTime":"2018-01-03T08:57Z",
			"MonitorStatus":"OPEN",
			"AddrPoolId":"1234abc",
			"MinAvailableAddrNum":2
		},
		{
			"Name":"Name test 2",
			"Status":"AVAILABLE",
			"CreateTimestamp":1527690629357,
			"AddrCount":2,
			"MonitorConfigId":"101abc",
			"Type":"IP",
			"UpdateTimestamp":1527690629357,
			"CreateTime":"2017-12-28T13:08Z",
			"UpdateTime":"2018-01-03T08:57Z",
			"MonitorStatus":"OPEN",
			"AddrPoolId":"2345abc",
			"MinAvailableAddrNum":2
		}
	]
}

Error codes

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