DescribeCloudGtmAddressPool - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves the configuration of a specified 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:DescribeCloudGtmAddressPool

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN: Chinese. en-US (default): English.	zh-CN
ClientToken	string	No	A client-generated token that ensures the idempotence of the request. Note: Make sure that the token is unique among different requests. The token can contain a maximum of 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
AddressPoolId	string	No	The unique ID of the address pool.	pool-89564674533755****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	6856BCF6-11D6-4D7E-AC53-FD579933522B
CreateTime	string	The time when the address pool was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The timestamp that indicates when the address pool was created.	1527690629357
UpdateTime	string	The time when the address pool was last modified.	2024-03-15T01:46Z
UpdateTimestamp	integer	The timestamp that indicates when the address pool was last modified.	1527690629357
AddressPoolId	string	The unique ID of the address pool.	pool-89564674533755****
AddressPoolName	string	The name of the address pool.	AddressPool-1
AddressPoolType	string	The type of the address pool. Valid values: IPv4 IPv6 domain	IPv4
AddressLbStrategy	string	The load balancing policy for the addresses in the address pool. Valid values: round_robin: For a DNS request from any source, all addresses are returned. The addresses are rotated in each response. sequence: For a DNS request from any source, the address with the highest priority is returned. Priority is determined by the `SerialNumber`, where a smaller value indicates a higher priority. If the highest-priority address is unavailable, the address with the next highest priority is returned. weight: A weight can be set for each address. DNS requests are resolved based on the specified weight ratio. source_nearest: Global Traffic Manager (GTM) returns an address based on the source of the DNS request. This implements proximity-based access for users.	round_robin
SequenceLbStrategyMode	string	The service recovery mode for a primary address that becomes available again when the load balancing policy is set to `sequence`. Valid values: preemptive: The system preferentially uses the address with a smaller `SerialNumber`. non_preemptive: The system continues to use the current address.	preemptive
EnableStatus	string	The status of the address pool. Valid values: enable: Enabled disable: Disabled	enable
HealthJudgement	string	The condition used to determine the health status of the address pool. Valid values: any_ok: At least one address is available. p30_ok: At least 30% of the addresses are available. p50_ok: At least 50% of the addresses are available. p70_ok: At least 70% of the addresses are available. all_ok: All addresses are available.	any_ok
HealthStatus	string	The health status of the address pool. Valid values: ok: The address pool is healthy. All addresses in the address pool are available. ok_alert: The address pool is in an alert state. Some addresses are unavailable, but the address pool is still considered healthy. In this state, DNS resolution is performed for available addresses, but not for unavailable addresses. exceptional: The address pool is unhealthy. Some or all addresses are unavailable, and the address pool is considered unhealthy.	ok
AvailableStatus	string	The availability status of the address pool. Valid values: available: Available. unavailable: Unavailable.	available
Addresses	object
Address	array<object>	A list of addresses.
	object	The information about the address.
CreateTime	string	The time when the address was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The timestamp that indicates when the address was created.	1527690629357
UpdateTime	string	The time when the address was last modified.	2024-03-15T01:46Z
UpdateTimestamp	integer	The timestamp that indicates when the address was last modified.	1527690629357
AddressId	string	The unique ID of the address.	addr-89518218114368****
WeightValue	integer	The weight of the address. This is an integer from 1 to 100. A weight can be set for each address. DNS requests are resolved based on the specified weight ratio.	1
SerialNumber	integer	The serial number of the address. This number indicates the priority of the address. A smaller value indicates a higher priority.	1
RequestSource	object
RequestSource	array	A list of DNS request sources.
	string	The source of the DNS request. GTM schedules traffic based on the egress IP address of the local DNS (LDNS) server used by the client. If the LDNS server supports Extension Mechanisms for DNS (EDNS) client subnet (ECS), GTM also schedules traffic based on the client's IP address.	["default"]
Name	string	The name of the address.	Address-1
Type	string	The type of the address. Valid values: IPv4: IPv4 address IPv6: IPv6 address domain: domain name	IPv4
Address	string	The IP address or domain name.	223.5.XX.XX
AttributeInfo	string	The source of the address. This parameter is not returned in the current version.	This parameter is not returned in this version
Remark	string	The notes on the address.	test
EnableStatus	string	The status of the address. This indicates whether the address is available. Valid values: enable: Enabled disable: Disabled	enable
AvailableMode	string	The health check-based failover mode for the address. Valid values: auto: The system automatically determines the address status based on health check results. If a health check fails, DNS resolution for the address stops. If the health check succeeds, DNS resolution for the address resumes. manual: You manually control the address status. If the address is in an unhealthy state, DNS resolution for the address stops and does not resume even if the health check succeeds. If the address is in a healthy state, DNS resolution for the address resumes. A health check failure only triggers an alert and does not stop DNS resolution.	auto
ManualAvailableStatus	string	The availability status set for the address when the failover mode is `manual`. Valid values: available: The address is available. DNS resolution is performed for the address. A health check failure only triggers an alert and does not stop DNS resolution. unavailable: The address is unavailable. DNS resolution for the address stops and does not resume even if the health check succeeds.	available
AvailableStatus	string	The availability status of the address. Valid values: available: Available. unavailable: Unavailable.	available
HealthStatus	string	The health check status of the address. Valid values: ok: All health check tasks for the associated health check templates are normal. ok_alert: Some health check tasks for the associated health check templates are abnormal, but the address is still considered healthy. ok_no_monitor: The address is not associated with any health check templates, and its status is normal. exceptional: Some or all health check tasks for the associated health check templates are abnormal, and the address is considered unhealthy.	ok
HealthJudgement	string	The condition used to determine the health status of the address. Valid values: any_ok: At least one health check is successful. p30_ok: At least 30% of the health checks are successful. p50_ok: At least 50% of the health checks are successful. p70_ok: At least 70% of the health checks are successful. all_ok: All health checks are successful.	any_ok
HealthTasks	object
HealthTask	array<object>	A list of health check tasks.
	object	The configuration of the health check task.
Port	integer	The service port on the address that is checked. This parameter is not supported when the health check protocol is `ping`.	80
TemplateId	string	The ID of the health check template associated with the address.	mtp-89518052425100**80
TemplateName	string	The name of the health check template.	IPv4-Ping
SeqNonPreemptiveSchedule	boolean	Indicates whether the address is a scheduling object in sequential (non-preemptive) mode. This applies to hybrid cloud management scenarios. Valid values: true false	false
Remark	string	The notes on the address.	test

Examples

Success response

JSON format

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "CreateTime": "2024-03-15T01:46Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-15T01:46Z",
  "UpdateTimestamp": 1527690629357,
  "AddressPoolId": "pool-89564674533755****",
  "AddressPoolName": "AddressPool-1",
  "AddressPoolType": "IPv4",
  "AddressLbStrategy": "round_robin",
  "SequenceLbStrategyMode": "preemptive",
  "EnableStatus": "enable",
  "HealthJudgement": "any_ok",
  "HealthStatus": "ok",
  "AvailableStatus": "available",
  "Addresses": {
    "Address": [
      {
        "CreateTime": "2024-03-15T01:46Z\n",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z\n",
        "UpdateTimestamp": 1527690629357,
        "AddressId": "addr-89518218114368****",
        "WeightValue": 1,
        "SerialNumber": 1,
        "RequestSource": {
          "RequestSource": [
            "[\"default\"]"
          ]
        },
        "Name": "Address-1",
        "Type": "IPv4",
        "Address": "223.5.XX.XX",
        "AttributeInfo": "当前版本不支持返回此参数。",
        "Remark": "test",
        "EnableStatus": "enable",
        "AvailableMode": "auto",
        "ManualAvailableStatus": "available",
        "AvailableStatus": "available",
        "HealthStatus": "ok",
        "HealthJudgement": "any_ok",
        "HealthTasks": {
          "HealthTask": [
            {
              "Port": 80,
              "TemplateId": "mtp-89518052425100**80\n",
              "TemplateName": "IPv4-Ping"
            }
          ]
        },
        "SeqNonPreemptiveSchedule": false
      }
    ]
  },
  "Remark": "test"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.