ListCloudGtmAddressPools - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Returns a list of address pools.

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

list

*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: English. This is the default value.	en-US
ClientToken	string	No	A client-generated token that is used to ensure the idempotence of the request. 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****
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. The maximum value is 100. The default value is 20.	20
AddressPoolName	string	No	The name of the address pool.	AddressPool-1
AddressPoolType	string	No	The type of the address pool. Valid values: IPv4: The address pool contains IPv4 addresses. IPv6: The address pool contains IPv6 addresses. domain: The address pool contains domain names.	IPv4
EnableStatus	string	No	The status of the address pool. Valid values: enable: The address pool is enabled. disable: The address pool is disabled.	enable
Remark	string	No	The remarks for the address pool.	test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	The number of entries returned on each page. The maximum value is 100. The default value is 20.	20
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of address pools.	11
AddressPools	object
AddressPool	array<object>	The list of address pools.
	object	The information about the address pool.
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 ID of the address pool.	pool-89528023225442**16
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: Round-robin. For all requests, addresses are returned in sequence. sequence: Sequential. Addresses with smaller sequential numbers have higher priority and are returned first. If an address with a smaller sequential number is unavailable, the next address in the sequence is returned. weight: Weighted. You can set a weight for each address. Addresses are returned based on their weight ratio. source_nearest: Source-based nearest return. Global Traffic Manager (GTM) returns different addresses based on the source of the DNS requests to implement proximity-based access.	round_robin
SequenceLbStrategyMode	string	The service recovery mode for a primary address when the load balancing policy is sequence. Valid values: preemptive: Preemptive mode. The system preferentially uses the address with a smaller sequential number after the address recovers. non_preemptive: Non-preemptive mode. The system continues to use the current address after the previous address recovers.	preemptive
EnableStatus	string	The status of the address pool. Valid values: enable: The address pool is enabled. disable: The address pool is disabled.	enable
HealthJudgement	string	The condition for determining the health status of the address pool. Valid values: any_ok: At least one health check probe is normal. p30_ok: At least 30% of the health check probes are normal. p50_ok: At least 50% of the health check probes are normal. p70_ok: At least 70% of the health check probes are normal. all_ok: All health check probes are normal.	any_ok
HealthStatus	string	The health status of the address pool. Valid values: ok: Normal. All addresses in the address pool are available. ok_alert: Warning. Some addresses in the address pool are unavailable, but the address pool is still considered normal. In this state, DNS resolution is performed for available addresses, but not for unavailable addresses. exceptional: Abnormal. Some or all addresses in the address pool are unavailable, and the address pool is considered abnormal.	ok
AvailableStatus	string	The availability status of the address pool. Valid values: available: The address pool is available. unavailable: The address pool is unavailable.	available
Addresses	object
Address	array<object>	The 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 ID of the address.	addr-89518218114368****
WeightValue	integer	The weight of the address. The value is an integer from 1 to 100. You can set a weight for each address. DNS requests are resolved based on the weight ratio.	1
SerialNumber	integer	The sequential number of the address. This number indicates the priority of the address. A smaller value indicates a higher priority.	1
RequestSource	object
RequestSource	array	The list of request sources.
	string	The source of the request. GTM schedules traffic based on the egress IP address of the local DNS (LDNS) server that a user uses. If the LDNS server supports Extension Mechanisms for DNS (EDNS) client subnet (ECS), GTM can also schedule traffic based on the user'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 cannot be returned in this version.
Remark	string	The remarks for the address.	test
EnableStatus	string	The status of the address. Valid values: enable: The address is enabled. disable: The address is disabled.	enable
AvailableMode	string	The health check-based failover method for the address. Valid values: auto: Automatic failover. If the health check result is abnormal, DNS resolution stops. If the health check result is normal, DNS resolution resumes. manual: Manual failover. If the address is in the abnormal state, DNS resolution stops. DNS resolution does not resume even if the health check result is normal. If the address is in the normal state, DNS resolution resumes. If the health check result is abnormal, an alert is generated, but DNS resolution does not stop.	auto
ManualAvailableStatus	string	The availability status of the address when the value of AvailableMode is manual. Valid values: available: Normal. In this state, DNS resolution is performed for the address. An alert is generated if the health check result is abnormal, but DNS resolution does not stop. unavailable: Abnormal. In this state, DNS resolution stops. DNS resolution does not resume even if the health check result is normal.	available
AvailableStatus	string	The availability status of the address. Valid values: available: The address is available. unavailable: The address is unavailable.	available
HealthStatus	string	The health status of the address. Valid values: ok: All health check probes for the address are normal. ok_alert: Some health check probes for the address are abnormal, but the address is still considered normal. ok_no_monitor: The address is not associated with any health check templates and is considered normal. exceptional: Some or all health check probes for the address are abnormal, and the address is considered abnormal.	ok
HealthJudgement	string	The condition for determining the health status of the address. Valid values: any_ok: At least one health check probe is normal. p30_ok: At least 30% of the health check probes are normal. p50_ok: At least 50% of the health check probes are normal. p70_ok: At least 70% of the health check probes are normal. all_ok: All health check probes are normal.	any_ok
HealthTasks	object
HealthTask	array<object>	The list of health check tasks.
	object	The information about the health check task.
Port	integer	The service port of 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.	mtp-89518052425100****
TemplateName	string	The name of the health check template.	IPv4-Ping
SeqNonPreemptiveSchedule	boolean	Indicates whether the address is a sequential non-preemptive scheduling object for hybrid cloud management scenarios. Valid values: true false	false
Remark	string	The remarks for the address pool.	test

Examples

Success response

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 11,
  "AddressPools": {
    "AddressPool": [
      {
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "AddressPoolId": "pool-89528023225442**16",
        "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",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "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****",
                    "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.