All Products
Search

This Product

    Alibaba Cloud DNS:DescribeCloudGtmAddressPool

    Document Center

    Alibaba Cloud DNS:DescribeCloudGtmAddressPool

    Last Updated:Apr 21, 2025

    Queries the configurations of 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.

    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:DescribeCloudGtmAddressPoolget
    *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
    AddressPoolIdstringNo

    The ID of the address pool. This ID uniquely identifies the address pool.

    		pool-89564674533755**96

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    Unique request identification code.

    		6856BCF6-11D6-4D7E-AC53-FD579933522B
    CreateTimestring

    Address pool creation time.

    		2024-03-15T01:46Z
    CreateTimestamplong

    Address pool creation time (timestamp).

    		1527690629357
    UpdateTimestring

    The last modification time of the address pool.

    		2024-03-15T01:46Z
    UpdateTimestamplong

    Last modification time of the address pool (timestamp).

    		1527690629357
    AddressPoolIdstring

    The ID of the address pool. This ID uniquely identifies the address pool.

    		pool-89564674533755**96
    AddressPoolNamestring

    Address pool name.

    		AddressPool-1
    AddressPoolTypestring

    Address pool type:

    • IPv4
    • IPv6
    • domain
    		IPv4
    AddressLbStrategystring

    Load balancing policy among addresses in the address pool:

    • round_robin: Round-robin, where for any source of DNS resolution requests, all addresses are returned, with a rotation of the order for every request.
    • sequence: Sequential, where for any source of DNS resolution requests, the address with the lower sequence number (indicating a higher priority, the smaller the number, the higher the priority) is returned. If the address with the lower sequence number is unavailable, the next address with a lower sequence number is returned.
    • weight: Weighted, supporting the setting of different weight values for each address to realize returning addresses according to the weight ratio of query resolutions.
    • source_nearest: Source-nearest, also known as intelligent resolution, where GTM can return different addresses based on the source of different DNS resolution requests, achieving the effect of users accessing nearby servers.
    		round_robin
    SequenceLbStrategyModestring

    The mode used if the address with the smallest sequence number is recovered. This parameter is returned only when the policy for load balancing between addresses is sequence. Valid values:

    • preemptive: The address with the smallest sequence number is preferentially used if this address is recovered.
    • non_preemptive: The current address is still used even if the address with the smallest sequence number is recovered.
    		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 Domain Name System (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: Available
    • unavailable: Unavailable
    		available
    Addressesarray<object>

    The addresses.

    Addressobject

    The address.

    CreateTimestring

    Address creation time.

    		2024-03-15T01:46Z
    CreateTimestamplong

    Address creation time (timestamp).

    		1527690629357
    UpdateTimestring

    The last time the address was modified.

    		2024-03-15T01:46Z
    UpdateTimestamplong

    The last modification time of the address (timestamp).

    		1527690629357
    AddressIdstring

    The address ID. This ID uniquely identifies the address.

    		addr-89518218114368**92
    WeightValueinteger

    Weight value (an integer between 1 and 100, inclusive), allowing different weight values to be set for each address, enabling resolution queries to return addresses according to the weighted ratio.

    		1
    SerialNumberinteger

    Sequence number, indicating the priority of address return, where smaller numbers have higher priority.

    		1
    RequestSourcearray

    The request source list.

    RequestSourcestring

    Request source, referring to the source of the request. GTM schedules based on the exit IP of the LocalDNS used by the terminal. If the LocalDNS supports ECS (edns-client-subnet), intelligent scheduling can also be performed based on the IP of the visiting terminal.

    		["default"]
    Namestring

    Address name.

    		Address-1
    Typestring

    The address type. Valid values:

    • IPv4: IPv4 address
    • IPv6: IPv6 address
    • domain: domain name
    		IPv4
    Addressstring

    IP address or domain name.

    		223.5.XX.XX
    AttributeInfostring

    Address ownership information, not supported in the current version.

    		Not supported in the current version.
    Remarkstring

    Remarks for the address.

    		test
    EnableStatusstring

    Address enable status, indicating whether the address is currently available:

    • enable: Enabled status
    • disable: Disabled status
    		enable
    AvailableModestring

    The failover method that is used if the address fails health checks. Valid values:

    • auto: the automatic mode. The system determines whether to return an address based on the health check results. If the address fails health checks, the system does not return the address. If the address passes health checks, the system returns the address.
    • manual: the manual mode. If an address is in the unavailable state, the address is not returned for DNS requests even if the address passes health checks. If an address is in the available state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks.
    		auto
    ManualAvailableStatusstring

    The availability state of the address when AvailableMode is set to manual. Valid values:

    • available: The address is normal. In this state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks.
    • unavailable: The address is abnormal. In this state, the address is not returned for DNS requests even if the address passes health checks.
    		available
    AvailableStatusstring

    Address availability status:

    • available: Address available
    • unavailable: Address unavailable
    		available
    HealthStatusstring

    The health check state of the address. Valid values:

    • ok: The address passes all health checks of the referenced health check templates.
    • ok_alert: The address fails some health checks of the referenced health check templates but the address is deemed normal.
    • ok_no_monitor: The address does not reference a health check template and is normal.
    • exceptional: The address fails some or all health checks of the referenced health check templates and the address is deemed abnormal.
    		ok
    HealthJudgementstring

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

    • any_ok: The health check results of at least one health check template are normal.
    • p30_ok: The health check results of at least 30% of health check templates are normal.
    • p50_ok: The health check results of at least 50% of health check templates are normal.
    • p70_ok: The health check results of at least 70% of health check templates are normal.
    • all_ok: The health check results of all health check templates are normal.
    		any_ok
    HealthTasksarray<object>

    Health check task list.

    HealthTaskobject

    Health check task configuration.

    Portinteger

    The target service port for health check probes. When the health check protocol is set to Ping, configuration of the service port is not supported.

    		80
    TemplateIdstring

    ID of the health check template associated with the address.

    		mtp-89518052425100**80
    TemplateNamestring

    Health check template name.

    		IPv4-Ping
    SeqNonPreemptiveScheduleboolean

    Indicates whether it is a sequential (non-preemptive) scheduling object for hybrid cloud management scenarios: - true: yes - false: no

    		false
    Remarkstring

    Remarks for the address.

    		test

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "CreateTime": "2024-03-15T01:46Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-15T01:46Z",
  "UpdateTimestamp": 1527690629357,
  "AddressPoolId": "pool-89564674533755**96",
  "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\n",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z\n",
        "UpdateTimestamp": 1527690629357,
        "AddressId": "addr-89518218114368**92\n",
        "WeightValue": 1,
        "SerialNumber": 1,
        "RequestSource": {
          "RequestSource": [
            "[\"default\"]"
          ]
        },
        "Name": "Address-1",
        "Type": "IPv4",
        "Address": "223.5.XX.XX",
        "AttributeInfo": "Not supported in the current version.",
        "Remark": "test",
        "EnableStatus": "enable",
        "AvailableMode": "auto",
        "ManualAvailableStatus": "available",
        "AvailableStatus": "available",
        "HealthStatus": "ok",
        "HealthJudgement": "any_ok",
        "HealthTasks": {
          "HealthTask": [
            {
              "Port": 80,
              "TemplateId": "mtp-89518052425100**80\n",
              "TemplateName": "IPv4-Ping"
            }
          ]
        },
        "SeqNonPreemptiveSchedule": false
      }
    ]
  },
  "Remark": "test"
}

    Error codes

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