DescribeGtmInstanceAddressPool - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Describes the details of an address pool.

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

get

*GtmInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language.	en
AddrPoolId	string	Yes	The ID of the address pool.	hrbpnf

Response elements

Element	Type	Description	Example
	object
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
Addrs	object
Addr	array<object>	The list of addresses in the address pool.
	object
Value	string	The IP address.	1.1.XX.XX
UpdateTimestamp	integer	The time when the address was last updated. This is a UNIX timestamp.	1527690629357
UpdateTime	string	The time when the address was last updated.	2017-12-28T13:08Z
AlertStatus	string	The health check status. Valid values: OK: Normal ALERT: An alert is triggered.	OK
LbaWeight	integer	The weight.	1
CreateTime	string	The time when the address was created.	2017-12-28T13:08Z
AddrId	integer	The ID of the address.	123
Mode	string	The return mode. Valid values: SMART: Intelligent return ONLINE: Always online OFFLINE: Always offline	SMART
CreateTimestamp	integer	The time when the address was created. This is a UNIX timestamp.	1527690629357
RequestId	string	The unique request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
CreateTime	string	The time when the address pool was created.	2017-12-28T13:08Z
AddrCount	integer	The number of addresses in the address pool.	2
Name	string	The name of the address pool.	名称
Type	string	The type of the address pool. Valid values: IP: IP address DOMAIN: Domain name	IP
UpdateTime	string	The time when the address pool was last updated.	2017-12-28T13:08Z
AddrPoolId	string	The ID of the address pool.	1234abc
UpdateTimestamp	integer	The time when the address pool was last updated. This is a UNIX timestamp.	1527690629357
MonitorConfigId	string	The ID of the monitoring configuration.	100abc
MinAvailableAddrNum	integer	The minimum number of available addresses.	1
MonitorStatus	string	The monitoring status. Valid values: OPEN: Enabled CLOSE: Disabled UNCONFIGURED: Not configured	OPEN
CreateTimestamp	integer	The time when the address pool was created. This is a UNIX timestamp.	1527690629357

Examples

Success response

JSON format

{
  "Status": "AVAILABLE",
  "Addrs": {
    "Addr": [
      {
        "Value": "1.1.XX.XX",
        "UpdateTimestamp": 1527690629357,
        "UpdateTime": "2017-12-28T13:08Z",
        "AlertStatus": "OK",
        "LbaWeight": 1,
        "CreateTime": "2017-12-28T13:08Z",
        "AddrId": 123,
        "Mode": "SMART",
        "CreateTimestamp": 1527690629357
      }
    ]
  },
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "CreateTime": "2017-12-28T13:08Z",
  "AddrCount": 2,
  "Name": "名称",
  "Type": "IP",
  "UpdateTime": "2017-12-28T13:08Z",
  "AddrPoolId": "1234abc",
  "UpdateTimestamp": 1527690629357,
  "MonitorConfigId": "100abc",
  "MinAvailableAddrNum": 1,
  "MonitorStatus": "OPEN",
  "CreateTimestamp": 1527690629357
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.