Queries 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 DescribeDnsGtmInstanceAddressPools

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

InstanceId String Yes instance1

The ID of the instance.

Lang String No en

The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.

PageNumber Integer No 1

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

PageSize Integer No 1

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

Response parameters

Parameter Type Example Description
AddrPools Array of AddrPool

The returned address pools.

AddrPool
AddrCount Integer 1

The number of addresses in the address pool.

AddrPoolId String pool-1

The ID of the address pool.

CreateTime String 2017-12-28T13:08Z

The time when the address pool was created.

CreateTimestamp Long 1527690629357

The timestamp that indicates when the address pool was created.

LbaStrategy String all_rr

The load balancing policy of the address pool. Valid values:

  • ALL_RR: returns all addresses.
  • RATIO: returns addresses by weight.
MonitorConfigId String abc123

The ID of the health check task.

MonitorStatus String open

Indicates whether health checks are configured. Valid values:

  • OPEN: enabled
  • CLOSE: disabled
  • UNCONFIGURED: not configured
Name String testpool

The name of the address pool.

Type String ipv4

The type of the address pool. Valid values:

  • IPV4: IPv4 address
  • IPV6: IPv6 address
  • DOMAIN: domain name
UpdateTime String 2017-12-28T13:08Z

The time when the address pool was updated.

UpdateTimestamp Long 1527690629357

The timestamp that indicates when the address pool was updated.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 1

The number of entries returned per page.

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

The ID of the request.

TotalItems Integer 1

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=DescribeDnsGtmInstanceAddressPools
&InstanceId=instance1
&<Common request parameters>

Sample success responses

XML format

<PageSize>1</PageSize>
<RequestId>6856BCF6-11D6-4D7E-AC53-FD579933522B</RequestId>
<PageNumber>1</PageNumber>
<TotalPages>1</TotalPages>
<TotalItems>1</TotalItems>
<AddrPools>
    <AddrPool>
        <Type>ipv4</Type>
        <LbaStrategy>all_rr</LbaStrategy>
        <CreateTime>2017-12-28T13:08Z</CreateTime>
        <UpdateTime>2017-12-28T13:08Z</UpdateTime>
        <AddrPoolId>pool-1</AddrPoolId>
        <UpdateTimestamp>1527690629357</UpdateTimestamp>
        <MonitorConfigId>abc123</MonitorConfigId>
        <MonitorStatus>open</MonitorStatus>
        <CreateTimestamp>1527690629357</CreateTimestamp>
        <Name>testpool</Name>
        <AddrCount>1</AddrCount>
    </AddrPool>
</AddrPools>

JSON format

{
	"PageSize": "1",
	"RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
	"PageNumber": "1",
	"TotalPages": "1",
	"TotalItems": "1",
	"AddrPools": {
		"AddrPool": [{
			"Type": "ipv4",
			"LbaStrategy": "all_rr",
			"CreateTime": "2017-12-28T13:08Z",
			"UpdateTime": "2017-12-28T13:08Z",
			"AddrPoolId": "pool-1",
			"UpdateTimestamp": "1527690629357",
			"MonitorConfigId": "abc123",
			"MonitorStatus": "open",
			"CreateTimestamp": "1527690629357",
			"Name": "testpool",
			"AddrCount": "1"
		}]
	}
}

Error codes

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