DescribeDnsGtmInstanceAddressPool - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the details of an address pool by its ID.

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:DescribeDnsGtmInstanceAddressPool

get

*gtmInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Default value: en. Valid values: en, zh, and ja.	en
AddrPoolId	string	Yes	The ID of the address pool. You can call the DescribeDnsGtmInstanceAddressPools operation to obtain the ID.	test*****

Response elements

Element	Type	Description	Example
	object
Addrs	object
Addr	array<object>	The addresses in the address pool.
	object
UpdateTimestamp	integer	The time when the address was last updated. This value is a UNIX timestamp.	1527690629357
AttributeInfo	string	The source region of the address. LineCode: The line code of the source region. This parameter is deprecated. Use LineCodes instead. LineName: The name of the source region. This parameter is deprecated. LineCodes: A list of line codes for the source regions.	"LineCode":"aliyun_r_cn-zhangjiakou", "LineName": "阿里云_华北3（张家口）"，“LineCodes”：["aliyun_r_cn-zhangjiakou"]
UpdateTime	string	The time when the address was last updated.	2017-12-28T13:08Z
AlertStatus	string	The health check status of the address. OK: Normal ALERT: Alert	OK
Remark	string	The remarks.	test
LbaWeight	integer	The weight.	1
Addr	string	The IP address.	1.1.XX.XX
CreateTime	string	The time when the address was created.	2017-12-28T13:08Z
Mode	string	The mode of the address. SMART: Smart return ONLINE: Always online OFFLINE: Always offline	SMART
CreateTimestamp	integer	The time when the address was created. This value is a UNIX timestamp.	1527690629357
RequestId	string	The unique request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
LbaStrategy	string	The load balancing policy. ALL_RR: Returns all addresses. RATIO: Returns addresses by weight.	ALL_RR
CreateTime	string	The time when the address pool was created.	2017-12-28T13:08Z
AddrCount	integer	The number of addresses in the address pool.	1
Name	string	The name of the address pool.	test
Type	string	The type of the address pool. 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
AddrPoolId	string	The ID of the address pool.	test*****
UpdateTimestamp	integer	The time when the address pool was last updated. This value is a UNIX timestamp.	1527690629357
MonitorConfigId	string	The ID of the health check configuration.	test1
MonitorStatus	string	The health check status of the address pool. OPEN: Enabled CLOSE: Disabled UNCONFIGURED: Not configured	OPEN
CreateTimestamp	integer	The time when the address pool was created. This value is a UNIX timestamp.	1527690629357

Examples

Success response

JSON format

{
  "Addrs": {
    "Addr": [
      {
        "UpdateTimestamp": 1527690629357,
        "AttributeInfo": "\"LineCode\":\"aliyun_r_cn-zhangjiakou\", \"LineName\": \"阿里云_华北3（张家口）\"，“LineCodes”：[\"aliyun_r_cn-zhangjiakou\"]",
        "UpdateTime": "2017-12-28T13:08Z",
        "AlertStatus": "OK",
        "Remark": "test",
        "LbaWeight": 1,
        "Addr": "1.1.XX.XX",
        "CreateTime": "2017-12-28T13:08Z",
        "Mode": "SMART",
        "CreateTimestamp": 1527690629357
      }
    ]
  },
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "LbaStrategy": "ALL_RR",
  "CreateTime": "2017-12-28T13:08Z",
  "AddrCount": 1,
  "Name": "test",
  "Type": "IPV4",
  "UpdateTime": "2017-12-28T13:08Z",
  "AddrPoolId": "test*****",
  "UpdateTimestamp": 1527690629357,
  "MonitorConfigId": "test1",
  "MonitorStatus": "OPEN",
  "CreateTimestamp": 1527690629357
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.