DescribeDnsGtmInstanceAddressPools - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:DescribeDnsGtmInstanceAddressPools	get	gtmInstance acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.	en
InstanceId	string	Yes	The ID of the instance.	instance1
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	1

Response parameters

Parameter	Type	Description	Example
	object
TotalPages	integer	The total number of pages returned.	1
TotalItems	integer	The total number of entries returned on all pages.	1
PageSize	integer	The number of entries returned per page.	1
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	6856BCF6-11D6-4D7E-AC53-FD579933522B
AddrPools	array<object>	The returned address pools.
AddrPool	object
Type	string	The type of the address pool. Valid values: IPV4: IPv4 address IPV6: IPv6 address DOMAIN: domain name	ipv4
UpdateTimestamp	long	The timestamp that indicates when the address pool was updated.	1527690629357
MonitorStatus	string	Indicates whether health checks are configured. 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.	pool-1
LbaStrategy	string	The load balancing policy of the address pool. 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 task.	abc123
CreateTimestamp	long	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.