DescribeGtmInstanceAddressPools - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Describes 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:DescribeGtmInstanceAddressPools

get

*GtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language.	en
InstanceId	string	Yes	The ID of the GTM instance.	gtmtest
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 for a paged query. 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.	20
RequestId	string	The unique request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
PageNumber	integer	The page number of the returned page.	1
TotalPages	integer	The total number of pages returned.	1
TotalItems	integer	The total number of entries returned.	2
AddrPools	object
AddrPool	array<object>	The address pools.
	object
Type	string	The type of the address pool. Valid values: IP: IP address DOMAIN: Domain name	IP
Status	string	The availability status of the address pool. Valid values: AVAILABLE: The address pool is available. NOT_AVAILABLE: The address pool is unavailable.	AVAILABLE
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.	100abc
MinAvailableAddrNum	integer	The minimum number of available addresses in the address pool.	2
UpdateTimestamp	integer	The timestamp that indicates when the address pool was last updated.	1527690629357
MonitorStatus	string	The health check status. Valid values: OPEN: Health checks are enabled. CLOSE: Health checks are disabled. UNCONFIGURED: Health checks are not configured.	OPEN
AddrPoolId	string	The ID of the address pool.	hrbpnf
Name	string	The name of the address pool.	test
AddrCount	integer	The number of addresses in the address pool.	2
CreateTimestamp	integer	The timestamp that indicates when the address pool was created.	1527690629357

Examples

Success response

JSON format

{
  "PageSize": 20,
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 2,
  "AddrPools": {
    "AddrPool": [
      {
        "Type": "IP",
        "Status": "AVAILABLE",
        "UpdateTime": "2017-12-28T13:08Z",
        "CreateTime": "2017-12-28T13:08Z",
        "MonitorConfigId": "100abc",
        "MinAvailableAddrNum": 2,
        "UpdateTimestamp": 1527690629357,
        "MonitorStatus": "OPEN",
        "AddrPoolId": "hrbpnf",
        "Name": "test",
        "AddrCount": 2,
        "CreateTimestamp": 1527690629357
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.