DescribeCloudGtmAddressReference - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the address pools and Global Traffic Manager (GTM) 3.0 instances that reference a specified address.

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

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 (default)	zh-CN
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Make sure that the client generates a unique token for each request. The token can contain a maximum of 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
AddressId	string	No	The unique ID of the address.	addr-89518218114368****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
AddressId	string	The unique ID of the address.	addr-89564584963974****
Name	string	The name of the address.	Address-1
Address	string	The IP address or domain name.	223.5.XX.XX
AddressPools	object
AddressPool	array<object>	The list of address pools.
	object	The information about the address pool.
AddressPoolId	string	The ID of the address pool.	pool-89528023225442****
AddressPoolName	string	The name of the address pool.	AddressPool-1
InstanceConfigs	object
InstanceConfig	array<object>	The list of instances that reference the address pool.
	object	The configuration information of the instance that references the address pool.
InstanceId	string	The ID of the GTM 3.0 instance.	gtm-cn-zz11t58****
InstanceName	string	The name of the instance.	test
ConfigId	string	The ID of the instance configuration. If you configure both A and AAAA records for the same access domain name and GTM instance, two instance configurations are generated. `ConfigId` uniquely identifies an instance configuration.	config-00****
VersionCode	string	The version of the GTM 3.0 instance: standard: Standard Edition ultimate: Ultimate Edition	ultimate
ScheduleZoneName	string	The primary domain name (for example, example.com) or subdomain name (for example, a.example.com) for GTM access. This is usually a domain name hosted on the authoritative zone in the Alibaba Cloud DNS console under the same account as the GTM instance.	example.com
ScheduleHostname	string	The host record of the GTM access domain name.	www
ScheduleDomainName	string	The GTM access domain name. It 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: A: IPv4 address AAAA: AAAA record CNAME: Canonical name	A
Ttl	integer	The global Time to Live (TTL) in seconds. This is the TTL value for the DNS record that resolves the access domain name to an address in the address pool. It affects the cache duration of the DNS record on a carrier's Local DNS server. You can specify a custom TTL value.	30
AddressPoolLbStrategy	string	The load balancing policy for the address pools: round_robin: Polling. For any DNS query, all address pools are returned. The order of the address pools is rotated for each query. sequence: Sequential. For any DNS query, the address pool with the lowest ordinal number is returned. A lower ordinal number indicates a higher priority. If an address pool is unavailable, the one with the next lowest ordinal number is returned. weight: Weighted. You can set a different weight for each address pool. DNS queries are then routed to address pools based on their weight ratios. source_nearest: Source-based. This is the smart DNS resolution feature. GTM can return different address pools based on the source of the DNS query. This allows users to access the nearest resource.	round_robin
SequenceLbStrategyMode	string	When the load balancing policy for address pools is `sequence`, this parameter specifies the service recovery mode for when a primary resource becomes available again: preemptive: Preemptive mode. The service switches back to the address pool with the lower ordinal number once it becomes available. non_preemptive: Non-preemptive mode. The service continues to use the current address pool even after the primary address pool becomes available.	preemptive
AvailableStatus	string	The service availability status of the domain name instance: available: Available. The domain name is enabled and its health status is Normal. unavailable: Unavailable. The domain name is disabled or its health status is Abnormal.	available
EnableStatus	string	The enabled status of the domain name instance: enable: Enabled. The smart scheduling policy of the GTM instance is active. disable: Disabled. The smart scheduling policy of the GTM instance is inactive.	enable
HealthStatus	string	The health status of the domain name instance: 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, available address pools are used for DNS resolution, while unavailable ones are not. exceptional: Abnormal. All address pools referenced by the access domain name are unavailable. In this case, addresses from the non-empty address pool with the lowest ordinal number are used for failover resolution to provide a response to the client.	ok
Remark	string	The remarks.	test
AddressPoolType	string	The type of the address pool: IPv4 IPv6 domain	IPv4
AddressLbStrategy	string	The load balancing policy for addresses within the address pool: round_robin: Polling. For any DNS query, all addresses are returned. The order of the addresses is rotated for each query. sequence: Sequential. For any DNS query, the address with the lowest ordinal number is returned. A lower ordinal number indicates a higher priority. If an address is unavailable, the one with the next lowest ordinal number is returned. weight: Weighted. You can set a different weight for each address. DNS queries are then routed to addresses based on their weight ratios. source_nearest: Source-based. This is the smart DNS resolution feature. GTM can return different addresses based on the source of the DNS query. This allows users to access the nearest resource.	round_robin
SequenceLbStrategyMode	string	When the load balancing policy for addresses is `sequence`, this parameter specifies the service recovery mode for when a primary resource becomes available again: preemptive: Preemptive mode. The service switches back to the address with the lower ordinal number once it becomes available. non_preemptive: Non-preemptive mode. The service continues to use the current address even after the primary address becomes available.	preemptive
EnableStatus	string	The enabled status of the address pool: enable: Enabled disable: Disabled	enable
HealthJudgement	string	The condition for determining the health status of the address pool: any_ok: At least one address in the pool is available. p30_ok: At least 30% of the addresses in the pool are available. p50_ok: At least 50% of the addresses in the pool are available. p70_ok: At least 70% of the addresses in the pool are available. all_ok: All addresses in the pool are available.	any_ok
HealthStatus	string	The health status of the address pool: ok: Normal. All addresses referenced by the address pool are available. ok_alert: Warning. Some addresses referenced by the address pool are unavailable, but the pool's status is still considered normal. In this state, available addresses are used for DNS resolution, while unavailable ones are not. exceptional: Abnormal. Some or all addresses referenced by the address pool are unavailable, and the pool's status is considered abnormal.	ok
AvailableStatus	string	The availability status of the address pool: available: Available unavailable: Unavailable	available
Remark	string	The remarks on the address pool.	pool-1

Examples

Success response

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "AddressId": "addr-89564584963974****",
  "Name": "Address-1",
  "Address": "223.5.XX.XX",
  "AddressPools": {
    "AddressPool": [
      {
        "AddressPoolId": "pool-89528023225442****",
        "AddressPoolName": "AddressPool-1",
        "InstanceConfigs": {
          "InstanceConfig": [
            {
              "InstanceId": "gtm-cn-zz11t58****",
              "InstanceName": "test",
              "ConfigId": "config-00****",
              "VersionCode": "ultimate",
              "ScheduleZoneName": "example.com\n",
              "ScheduleHostname": "www",
              "ScheduleDomainName": "www.example.com",
              "ScheduleRrType": "A",
              "Ttl": 30,
              "AddressPoolLbStrategy": "round_robin",
              "SequenceLbStrategyMode": " preemptive",
              "AvailableStatus": "available",
              "EnableStatus": "enable",
              "HealthStatus": "ok",
              "Remark": "test"
            }
          ]
        },
        "AddressPoolType": "IPv4",
        "AddressLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "EnableStatus": "enable",
        "HealthJudgement": "any_ok",
        "HealthStatus": "ok",
        "AvailableStatus": "available",
        "Remark": "pool-1"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.