DescribeDnsGtmInstanceAddressPool - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries detailed information about an address pool 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:DescribeDnsGtmInstanceAddressPool	get	gtmInstance acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the values of specific response parameters. Default value: en. Valid values: en, zh, and ja.	en
AddrPoolId	string	Yes	The ID of the address pool.	testpool1

Response parameters

Parameter	Type	Description	Example
	object
Type	string	The type of the address pool. Valid values: IPV4: IPv4 address IPV6: IPv6 address DOMAIN: domain name	ipv4
UpdateTime	string	The time when the address pool was last updated.	2017-12-28T13:08Z
CreateTime	string	The time when the address pool was created.	2017-12-28T13:08Z
MonitorConfigId	string	The ID of the health check configuration.	test1
UpdateTimestamp	long	The timestamp that indicates the time when the address pool was last updated.	1527690629357
MonitorStatus	string	Indicates the status of the health check. Valid values: OPEN: The health check is enabled. CLOSE: The health check is disabled. UNCONFIGURED: The health check is not configured.	open
RequestId	string	The ID of the request.	6856BCF6-11D6-4D7E-AC53-FD579933522B
AddrPoolId	string	The ID of the address pool.	testpool1
LbaStrategy	string	The load balancing policy for the address pool. Valid values: ALL_RR: returns all addresses. RATIO: returns addresses by weight.	all_rr
AddrCount	integer	The number of addresses in the address pool.	1
Name	string	The name of the address pool.	test
CreateTimestamp	long	The timestamp that indicates the time when the address pool was created.	1527690629357
Addrs	array<object>	The addresses in the address pool.
Addr	object
UpdateTimestamp	long	The timestamp that indicates the time when the address was last updated.	1527690629357
AttributeInfo	string	The source region of the address. lineCode: the line code of the source region of the address. This parameter is deprecated, and lineCodes prevails. lineName: the line name of the source region of the address. This parameter is deprecated. lineCodes: the line codes of the source regions of the address.	"lineCode":"aliyun_r_cn-zhangjiakou", "lineName": "Alibaba Cloud_China (Zhangjiakou)", "lineCodes": \["aliyun_r_cn-zhangjiakou"]
UpdateTime	string	The time when the address was last updated.	2017-12-28T13:08Z
AlertStatus	string	The status of the last health check on the address. Valid values: OK: No active alerts are triggered. ALERT: Alerts are triggered based on the alert rules.	ok
Remark	string	The description of the address.	test
LbaWeight	integer	The weight of the address.	1
Addr	string	The address.	1.1.1.1
CreateTime	string	The time when the address was added into the address pool.	2017-12-28T13:08Z
Mode	string	The mode of the address. Valid values: SMART: smart return ONLINE: always online OFFLINE: always offline	online
CreateTimestamp	long	The timestamp that indicates the time when the address was added into the address pool.	1527690629357

Examples

Sample success responses

JSONformat

{
  "Type": "ipv4",
  "UpdateTime": "2017-12-28T13:08Z",
  "CreateTime": "2017-12-28T13:08Z",
  "MonitorConfigId": "test1",
  "UpdateTimestamp": 1527690629357,
  "MonitorStatus": "open",
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "AddrPoolId": "testpool1",
  "LbaStrategy": "all_rr",
  "AddrCount": 1,
  "Name": "test",
  "CreateTimestamp": 1527690629357,
  "Addrs": {
    "Addr": [
      {
        "UpdateTimestamp": 1527690629357,
        "AttributeInfo": "\"lineCode\":\"aliyun_r_cn-zhangjiakou\", \"lineName\": \"Alibaba Cloud_China (Zhangjiakou)\", \"lineCodes\": \\[\"aliyun_r_cn-zhangjiakou\"]\n",
        "UpdateTime": "2017-12-28T13:08Z",
        "AlertStatus": "ok",
        "Remark": "test",
        "LbaWeight": 1,
        "Addr": "1.1.1.1",
        "CreateTime": "2017-12-28T13:08Z",
        "Mode": "online",
        "CreateTimestamp": 1527690629357
      }
    ]
  }
}

Error codes

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