All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDnsGtmInstanceAddressPools

Last Updated:Mar 15, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeDnsGtmInstanceAddressPoolsREAD
  • gtmInstance
    acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

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

en
InstanceIdstringYes

The ID of the instance.

instance1
PageNumberintegerNo

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

1
PageSizeintegerNo

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

1

Response parameters

ParameterTypeDescriptionExample
object
TotalPagesinteger

The total number of pages returned.

1
TotalItemsinteger

The total number of entries returned on all pages.

1
PageSizeinteger

The number of entries returned per page.

1
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

6856BCF6-11D6-4D7E-AC53-FD579933522B
AddrPoolsobject []

The returned address pools.

Typestring

The type of the address pool. Valid values:

  • IPV4: IPv4 address
  • IPV6: IPv6 address
  • DOMAIN: domain name
ipv4
UpdateTimestamplong

The timestamp that indicates when the address pool was updated.

1527690629357
MonitorStatusstring

Indicates whether health checks are configured. Valid values:

  • OPEN: enabled
  • CLOSE: disabled
  • UNCONFIGURED: not configured
open
UpdateTimestring

The time when the address pool was updated.

2017-12-28T13:08Z
CreateTimestring

The time when the address pool was created.

2017-12-28T13:08Z
AddrPoolIdstring

The ID of the address pool.

pool-1
LbaStrategystring

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

  • ALL_RR: returns all addresses.
  • RATIO: returns addresses by weight.
all_rr
Namestring

The name of the address pool.

testpool
AddrCountinteger

The number of addresses in the address pool.

1
MonitorConfigIdstring

The ID of the health check task.

abc123
CreateTimestamplong

The timestamp that indicates when the address pool was created.

1527690629357

Examples

Sample success responses

JSONformat

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

Error codes

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