DescribeCloudGtmAddressPoolReference - Alibaba Cloud DNS

Retrieves information about the instances that reference 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:DescribeCloudGtmAddressPoolReference

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: English. This is the default value.	en-US
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a token to make sure that it 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-89528023225442****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	853805EA-3D47-47D5-9A1A-A45C24313ABD
AddressPoolId	string	The unique ID of the address pool.	pool-89528023225442****
AddressPoolName	string	The name of the address pool.	app
InstanceConfigs	object
InstanceConfig	array<object>	A list of instances that reference the address pool.
	object	An instance that references the address pool.
InstanceId	string	The ID of the Global Traffic Manager (GTM) 3.0 instance.	gtm-cn-jmp3qnw****
ConfigId	string	The configuration ID of the domain name instance. You can configure both A and AAAA records for the same access domain name and GTM instance. In this case, two configurations are created for the GTM instance. The ConfigId parameter uniquely identifies a configuration.	config-00****
VersionCode	string	The edition of the GTM 3.0 instance. Valid values: standard: Standard Edition ultimate: Ultimate Edition	ultimate
InstanceName	string	The name of the instance.	test
ScheduleZoneName	string	The primary domain name, such as example.com, or the subdomain name, such as a.example.com, that is used to access GTM. This domain name is usually hosted in an authoritative zone in the Alibaba Cloud DNS console. The authoritative zone belongs to the same account as the GTM instance.	example.com
ScheduleHostname	string	The host record of the domain name that is used to access GTM.	www
ScheduleDomainName	string	The domain name that is used to access GTM. The domain name is a combination of the host record (ScheduleHostname) and the primary or subdomain name (ScheduleZoneName).	www.example.com
ScheduleRrType	string	The DNS record type of the scheduling domain name. Valid values: A: IPv4 address AAAA: IPv6 address CNAME: canonical name	A
Ttl	integer	The global time to live (TTL). This is the TTL of the DNS record that maps the access domain name to an address in the address pool. The global TTL affects how long the DNS record is cached on a carrier's recursive DNS server. You can specify a custom TTL.	30
AddressPoolLbStrategy	string	The load balancing policy for the address pools. Valid values: round_robin: Polling. All address pools are returned for any DNS request. The address pools are rotated for each request. sequence: Sequential. The address pool with the smallest ordinal number is returned for any DNS request. A smaller ordinal number indicates a higher priority. If the address pool with the highest priority is unavailable, the address pool with the second highest priority is returned. weight: Weighted. You can set different weights for each address pool. DNS requests are then routed to address pools based on their weights. source_nearest: Source proximity. This is the intelligent DNS resolution feature. GTM returns different address pools based on the source of DNS requests. This allows users to access the nearest location.	round_robin
SequenceLbStrategyMode	string	The service recovery mode when the load balancing policy is sequence and a high-priority resource recovers from an exception. Valid values: preemptive: Preemptive mode. If a high-priority address pool recovers, traffic is immediately switched to it. non_preemptive: Non-preemptive mode. If a high-priority address pool recovers, traffic remains with the current address pool.	preemptive
AvailableStatus	string	The availability status of the domain name instance service. Valid values: available: The domain name is enabled and healthy. The service for the access domain name is available. unavailable: The domain name is disabled or unhealthy. The service for the access domain name is unavailable.	available
EnableStatus	string	The enabled status of the domain name instance. Valid values: enable: Enabled. The intelligent scheduling policy of the GTM instance is active. disable: Disabled. The intelligent scheduling policy of the GTM instance is inactive.	enable
HealthStatus	string	The health status of the domain name instance. Valid values: ok: Normal. All address pools referenced by the access domain name are available. ok_alert: Warning. Some of the address pools referenced by the access domain name are unavailable. In this state, DNS resolution proceeds for available address pools, but stops for unavailable ones. exceptional: Abnormal. All address pools referenced by the access domain name are unavailable. In this case, failover resolution is performed using addresses from the non-empty address pool with the smallest ordinal number. This helps clients receive a DNS response.	ok
Remark	string	The remarks.	test

Examples

Success response

JSON format

{
  "RequestId": "853805EA-3D47-47D5-9A1A-A45C24313ABD",
  "AddressPoolId": "pool-89528023225442****",
  "AddressPoolName": "app",
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-jmp3qnw****",
        "ConfigId": "config-00****",
        "VersionCode": "ultimate",
        "InstanceName": "test",
        "ScheduleZoneName": "example.com",
        "ScheduleHostname": "www",
        "ScheduleDomainName": "www.example.com",
        "ScheduleRrType": "A",
        "Ttl": 30,
        "AddressPoolLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "AvailableStatus": "available",
        "EnableStatus": "enable",
        "HealthStatus": "ok",
        "Remark": "test"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.