All Products
Search
Document Center

Alibaba Cloud DNS:DescribeGtmInstanceAddressPool

Last Updated:Mar 15, 2024

You can call this operation to query the details about an address pool of a Global Traffic Manager (GTM) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeGtmInstanceAddressPoolREAD
  • GtmInstance
    acs:alidns::{#accountId}:gtminstance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language used by the user.

en
AddrPoolIdstringYes

The ID of the address pool that you want to query.

1234

Response parameters

ParameterTypeDescriptionExample
object
Typestring

The type of the address pool. Valid values:

  • IP: IP address
  • DOMAIN: Domain name
IP
Statusstring

The availability status of the address pool. Valid values:

  • AVAILABLE: Available
  • NOT_AVAILABLE: Unavailable
AVAILABLE
UpdateTimestring

The last time when the address pool was updated.

2017-12-28T13:08Z
CreateTimestring

The time when the address pool was created.

2017-12-28T13:08Z
MonitorConfigIdstring

The health check ID of the address pool.

100abc
UpdateTimestamplong

A timestamp that indicates the last time the address pool was updated.

1527690629357
MinAvailableAddrNuminteger

The minimum number of available addresses in the address pool.

2
MonitorStatusstring

Indicates whether health check was enabled for the address pool. Valid values:

  • OPEN: Enabled
  • CLOSE: Disabled
  • UNCONFIGURED: Not configured
OPEN
RequestIdstring

The ID of the request.

6856BCF6-11D6-4D7E-AC53-FD579933522B
AddrPoolIdstring

The ID of the address pool.

1234abc
AddrCountinteger

The number of addresses in the address pool queried.

2
Namestring

The name of the address pool.

Addrsobject []

The addresses in the address pool.

Valuestring

The address.

1.1.1.1
UpdateTimestamplong

A timestamp that indicates the last time when the address was updated.

1527690629357
UpdateTimestring

The last time when the address was updated.

2017-12-28T13:08Z
AlertStatusstring

Indicates whether health check was enabled for the address. Valid values:

  • OK: Normal
  • ALERT: Alert
OK
LbaWeightinteger

The weight of the address.

1
CreateTimestring

The time when the address pool was created.

2017-12-28T13:08Z
AddrIdlong

The ID of the address.

123
Modestring

The mode of the address. Valid values:

  • SMART: Intelligent return
  • ONLINE: Always online
  • OFFLINE: Always offline
SMART

Examples

Sample success responses

JSONformat

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

Error codes

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