DescribeCloudGtmAddressPoolReference - Alibaba Cloud DNS

Queries the information about the access domain names that reference an address pool.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:DescribeCloudGtmAddressPoolReference	get	All Resources ``	none	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	en-US
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	1ae05db4-10e7-11ef-b126-00163e24**22
AddressPoolId	string	No	The ID of the address pool. This ID uniquely identifies the address pool.	pool-89528023225442**16

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Unique request identification code.	853805EA-3D47-47D5-9A1A-A45C24313ABD
AddressPoolId	string	The ID of the address pool. This ID uniquely identifies the address pool.	pool-89528023225442**16
AddressPoolName	string	Address pool name.	app
InstanceConfigs	array<object>	The access domain names that reference the address pool.
InstanceConfig	object	The access domain name that references the address pool.
InstanceId	string	The ID of the Global Traffic Manager (GTM) 3.0 instance.	gtm-cn-jmp3qnw**03
ConfigId	string	The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.	config-000**1
VersionCode	string	Global Traffic Management version 3.0 instance types: standard: Standard Edition ultimate: Ultimate Edition	ultimate
InstanceName	string	Instance name.	test
ScheduleZoneName	string	The zone such as example.com or subzone such as a.example.com of the access domain name. In most cases, the zone or subzone is hosted by the Public Authoritative DNS module of Alibaba Cloud DNS. This zone belongs to the account to which the GTM instance belongs.	example.com
ScheduleHostname	string	Host record of the domain accessed by GTM.	www
ScheduleDomainName	string	The access domain name. The value of this parameter is composed of the value of ScheduleHostname and the value of ScheduleZoneName.	www.example.com
ScheduleRrType	string	DNS record types for scheduling domains: A: IPv4 address AAAA: IPv6 address CNAME: Domain name	A
Ttl	integer	Global TTL, the TTL value for resolving the accessed domain name to addresses in the address pool, which affects the caching time of DNS records in the operator's LocalDNS. Supports custom TTL values.	30
AddressPoolLbStrategy	string	The policy for load balancing between address pools. Valid values: round_robin: All address pools are returned for Domain Name System (DNS) requests from any source. All address pools are sorted in round-robin mode each time they are returned. sequence: The address pool with the smallest sequence number is preferentially returned for DNS requests from any source. The sequence number indicates the priority for returning the address pool. A smaller sequence number indicates a higher priority. If the address pool with the smallest sequence number is unavailable, the address pool with the second smallest sequence number is returned. weight: You can set a different weight value for each address pool. This way, address pools are returned based on the weight values. source_nearest: Different address pools are returned based on the sources of DNS requests. This way, users can access nearby address pools.	round_robin
SequenceLbStrategyMode	string	The mode used if the address pool with the smallest sequence number is recovered. This parameter is returned when AddressPoolLbStrategy is set to sequence. Valid values: preemptive: The address pool with the smallest sequence number is preferentially used if this address pool is recovered. non_preemptive: The current address pool is still used even if the address pool with the smallest sequence number is recovered.	preemptive
AvailableStatus	string	The availability state of the access domain name. Valid values: available: If the access domain name is enabled and the health state is normal, the access domain name is deemed available. unavailable: If the access domain name is disabled or the health state is abnormal, the access domain name is deemed unavailable.	available
EnableStatus	string	The enabling state of the access domain name. Valid values: enable: The access domain name is enabled and the intelligent scheduling policy of the corresponding GTM instance takes effect. disable: The access domain name is disabled and the intelligent scheduling policy of the corresponding GTM instance does not take effect.	enable
HealthStatus	string	The health state of the access domain name. Valid values: ok: The health state of the access domain name is normal and all address pools that are referenced by the access domain name are available. ok_alert: The health state of the access domain name is warning and some of the address pools that are referenced by the access domain name are unavailable. In this case, only the available address pools are returned for DNS requests. exceptional: The health state of the access domain name is abnormal and all address pools that are referenced by the access domain name are unavailable. In this case, addresses in the non-empty address pool with the smallest sequence number are preferentially used for fallback resolution. This returns DNS results for clients as much as possible.	ok
Remark	string	Remarks.	test

Examples

Sample success responses

JSONformat

{
  "RequestId": "853805EA-3D47-47D5-9A1A-A45C24313ABD",
  "AddressPoolId": "pool-89528023225442**16",
  "AddressPoolName": "app",
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-jmp3qnw**03",
        "ConfigId": "config-000**1",
        "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

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