DescribeDnsGtmInstanceAddressPools - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves the address pools of a Global Traffic Manager (GTM) instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeDnsGtmInstanceAddressPools

get

*gtmInstance

acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: en, zh, and ja. The default value is en.	en
InstanceId	string	Yes	The instance ID. For more information, see DescribeDnsGtmInstances.	gtm-cn-wwo3a3hbz**
PageNumber	integer	No	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The maximum value is 100. The default value is 20.	20

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page. The maximum value is 100. The default value is 20.	1
RequestId	string	The unique request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
PageNumber	integer	The page number. The value starts from 1. The default value is 1.	1
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of entries.	1
AddrPools	object
AddrPool	array<object>	The list of address pools.
	object
Type	string	The type of the address pool. Valid values: IPV4: IPv4 address IPV6: IPv6 address DOMAIN: domain name	IPV4
UpdateTimestamp	integer	The time when the address pool was updated. This is a UNIX timestamp.	1527690629357
MonitorStatus	string	The health check status. Valid values: OPEN: Enabled CLOSE: Disabled UNCONFIGURED: Not configured	OPEN
UpdateTime	string	The time when the address pool was updated.	2017-12-28T13:08Z
CreateTime	string	The time when the address pool was created.	2017-12-28T13:08Z
AddrPoolId	string	The ID of the address pool.	hr****
LbaStrategy	string	The load balancing policy. Valid values: ALL_RR: Returns all addresses. RATIO: Returns addresses by weight.	ALL_RR
Name	string	The name of the address pool.	testpool
AddrCount	integer	The number of addresses in the address pool.	1
MonitorConfigId	string	The ID of the health check configuration.	abc****
CreateTimestamp	integer	The time when the address pool was created. This is a UNIX timestamp.	1527690629357

Examples

Success response

JSON format

{
  "PageSize": 1,
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 1,
  "AddrPools": {
    "AddrPool": [
      {
        "Type": "IPV4",
        "UpdateTimestamp": 1527690629357,
        "MonitorStatus": "OPEN",
        "UpdateTime": "2017-12-28T13:08Z",
        "CreateTime": "2017-12-28T13:08Z",
        "AddrPoolId": "hr****",
        "LbaStrategy": "ALL_RR",
        "Name": "testpool",
        "AddrCount": 1,
        "MonitorConfigId": "abc****",
        "CreateTimestamp": 1527690629357
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.