All Products
Search

This Product

    Alibaba Cloud DNS:DescribeCloudGtmAddressReference

    Document Center

    Alibaba Cloud DNS:DescribeCloudGtmAddressReference

    Last Updated:Apr 21, 2025

    Queries the information about the address pools and Global Traffic Manager (GTM) 3.0 instances that reference an address.

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    alidns:DescribeCloudGtmAddressReferenceget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AcceptLanguagestringNo

    The language of the response. Valid values:

    • zh-CN: Chinese
    • en-US (default): English
    		en-US
    ClientTokenstringNo

    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
    AddressIdstringNo

    The address ID. This ID uniquely identifies the address.

    		addr-89518218114368**92

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    Unique request identification code.

    		536E9CAD-DB30-4647-AC87-AA5CC38C5382
    AddressIdstring

    The address ID. This ID uniquely identifies the address.

    		addr-89564584963974**40
    Namestring

    Address name.

    		Address-1
    Addressstring

    IP address or domain name.

    		223.5.XX.XX
    AddressPoolsarray<object>

    The address pools.

    AddressPoolobject

    The address pool.

    AddressPoolIdstring

    The ID of the address pool.

    		pool-895280232254422016
    AddressPoolNamestring

    Address pool name.

    		AddressPool-1
    InstanceConfigsarray<object>

    The instances that reference the address pool.

    InstanceConfigobject

    The instance that references the address pool.

    InstanceIdstring

    The ID of the GTM 3.0 instance.

    		gtm-cn-zz11t58**0k
    InstanceNamestring

    Instance name.

    		test
    ConfigIdstring

    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-00**01
    VersionCodestring

    Global Traffic Management version 3.0 instance types:

    • standard: Standard Edition
    • ultimate: Ultimate Edition
    		ultimate
    ScheduleZoneNamestring

    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
    ScheduleHostnamestring

    Host record of the domain accessed by GTM.

    		www
    ScheduleDomainNamestring

    The access domain name. The value of this parameter is composed of the value of ScheduleHostname and the value of ScheduleZoneName.

    		www.example.com
    ScheduleRrTypestring

    DNS record types for the scheduling domain:

    • A: IPv4 address
    • AAAA: IPv6 address
    • CNAME: Domain name
    		A
    Ttlinteger

    Global TTL (in seconds), the TTL value for domain name resolution to addresses in the address pool, which affects the caching time of DNS records in the ISP's LocalDNS. Custom TTL values are supported.

    		30
    AddressPoolLbStrategystring

    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
    SequenceLbStrategyModestring

    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
    AvailableStatusstring

    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
    EnableStatusstring

    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
    HealthStatusstring

    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
    Remarkstring

    Remarks.

    		test
    AddressPoolTypestring

    Address pool type:

    • IPv4
    • IPv6
    • domain
    		IPv4
    AddressLbStrategystring

    Load balancing policy among addresses in the address pool:

    • round_robin: Round-robin, for any source of DNS resolution requests, all addresses are returned, with a rotation sort applied to all addresses each time.
    • sequence: Sequential, for any source of DNS resolution requests, returns the address with the smaller sequence number (the sequence number indicates the priority of address return, with smaller numbers having higher priority). If the address with the smaller sequence number is unavailable, the next address with a smaller sequence number is returned.
    • weight: Weighted, supports setting different weight values for each address, realizing the return of addresses according to the ratio of weight for DNS query resolutions.
    • source_nearest: Source-nearest, i.e., intelligent resolution function, where GTM can return different addresses based on the source of different DNS resolution requests, achieving the effect of users accessing nearby.
    		round_robin
    SequenceLbStrategyModestring

    Load balancing policy between addresses in sequential mode during the recovery of preceding resources service mode:

    • preemptive: Preemption mode, where upon recovery of preceding resources, priority is given to using addresses with smaller sequence numbers;
    • non_preemptive: Non-preemption mode, where upon recovery of preceding resources, the current address continues to be used;
    		preemptive
    EnableStatusstring

    Address pool status:

    • enable: Enabled status
    • disable: Disabled status
    		enable
    HealthJudgementstring

    The condition for determining the health status of the address pool. Valid values:

    • any_ok: At least one address in the address pool is available.
    • p30_ok: At least 30% of the addresses in the address pool are available.
    • p50_ok: At least 50% of the addresses in the address pool are available.
    • p70_ok: At least 70% of the addresses in the address pool are available.
    • all_ok: All addresses in the address pool are available.
    		any_ok
    HealthStatusstring

    The health state of the address pool. Valid values:

    • ok: The health state of the address pool is normal and all addresses that are referenced by the address pool are available.
    • ok_alert: The health state of the address pool is warning and some of the addresses that are referenced by the address pool are unavailable. However, the address pool is deemed normal. In this case, only the available addresses are returned for DNS requests.
    • exceptional: The health state of the address pool is abnormal and some or all of the addresses that are referenced by the address pool are unavailable. In this case, the address pool is deemed abnormal.
    		ok
    AvailableStatusstring

    Address pool availability status:

    • available
    • unavailable
    		available
    Remarkstring

    Remarks for the address pool.

    		pool-1

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "AddressId": "addr-89564584963974**40",
  "Name": "Address-1",
  "Address": "223.5.XX.XX",
  "AddressPools": {
    "AddressPool": [
      {
        "AddressPoolId": "pool-895280232254422016",
        "AddressPoolName": "AddressPool-1",
        "InstanceConfigs": {
          "InstanceConfig": [
            {
              "InstanceId": "gtm-cn-zz11t58**0k",
              "InstanceName": "test",
              "ConfigId": "config-00**01",
              "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

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