All Products
Search

This Product

    Alibaba Cloud DNS:AddDnsGtmAddressPool

    Document Center

    Alibaba Cloud DNS:AddDnsGtmAddressPool

    Last Updated:Sep 09, 2025

    Adds 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:AddDnsGtmAddressPool

    create

    *gtmInstance

    acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

    The language of some returned parameters. Default value: en. Valid values: en, zh, and ja.

    en
    InstanceId

    string

    Yes

    The instance ID. Call DescribeDnsGtmInstances to obtain the instance ID.

    gtm-cn-cs02xyk****
    Name

    string

    Yes

    The name of the address pool.

    test
    Type

    string

    Yes

    The type of the address pool. Valid values:

    • IPV4: IPv4 address

    • IPV6: IPv6 address

    • DOMAIN: domain name

    IPV4
    LbaStrategy

    string

    Yes

    The load balancing policy. Valid values:

    • ALL_RR: returns all addresses.

    • RATIO: returns addresses by weight.

    ALL_RR
    MonitorStatus

    string

    No

    The status of the health check feature. Default value: CLOSE. If you set this parameter to OPEN, the health check configuration is verified. Otherwise, the configuration is ignored.

    • OPEN: enabled

    • CLOSE: disabled

    OPEN
    ProtocolType

    string

    No

    The health check protocol. Valid values:

    • HTTP

    • HTTPS

    • PING

    • TCP

    TCP
    Interval

    integer

    No

    The health check interval. Unit: seconds.

    60
    EvaluationCount

    integer

    No

    The number of consecutive failed health checks.

    2
    Timeout

    integer

    No

    The timeout period. Unit: milliseconds.

    2000
    MonitorExtendInfo

    string

    No

    The extended information. This parameter is a JSON string. The required parameters vary based on the health check protocol:

    • HTTP and HTTPS:

      • port: The health check port.

      • host: The host settings.

      • path: The URL path.

      • code: The return code. A response with a status code greater than this value is considered abnormal. Valid values: 400 and 500.

      • failureRate: The failure rate.

      • sni: Specifies whether to enable Server Name Indication (SNI). This parameter is available only for the HTTPS protocol.

        • true: Enable SNI.

        • Other values: Disable SNI.

      • nodeType: The type of the health check node when the address pool type is DOMAIN. Valid values:

        • IPV4

        • IPV6

    • PING:

      • failureRate: The failure rate.

      • packetNum: The number of ping packets.

      • packetLossRate: The packet loss rate.

      • nodeType: The type of the health check node when the address pool type is DOMAIN. Valid values:

        • IPV4

        • IPV6

    • TCP:

      • port: The health check port.

      • failureRate: The failure rate.

      • nodeType: The type of the health check node when the address pool type is DOMAIN. Valid values:

        • IPV4

        • IPV6

    {"failureRate":50,"port":80}
    Addr

    array<object>

    Yes

    The list of addresses in the address pool.

    object

    No

    AttributeInfo

    string

    Yes

    The source region of the address. This parameter is a JSON string.

    • lineCode: The line code of the source region.

    • lineCodeRectifyType: The rectification type for the line code. Default value: AUTO.

      • NO_NEED: No rectification is performed.

      • RECTIFIED: The line code is rectified.

      • AUTO: The line code is automatically rectified.

    {"lineCodeRectifyType":"AUTO", "lineCode":[]}
    Remark

    string

    No

    The remarks.

    test
    LbaWeight

    integer

    No

    The weight.

    1
    Addr

    string

    Yes

    The address.

    223.5.XX.XX
    Mode

    string

    Yes

    The mode. Valid values:

    • SMART: smart return

    • ONLINE: always online

    • OFFLINE: always offline

    SMART
    IspCityNode

    array<object>

    No

    The list of health check nodes. If MonitorStatus is set to OPEN, you must specify at least one valid health check node.

    object

    No

    CityCode

    string

    No

    The city code. If MonitorStatus is set to OPEN, CityCode is required.

    For information about the valid values, see the response of the DescribeDnsGtmMonitorAvailableConfig operation.

    503
    IspCode

    string

    No

    If MonitorStatus is set to OPEN, IspCode is required. For information about the valid values, see the response of the DescribeDnsGtmMonitorAvailableConfig operation.

    465

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The unique request ID.

    6856BCF6-11D6-4D7E-AC53-FD5799335**B
    AddrPoolId

    string

    The ID of the address pool.

    hrbv**
    MonitorConfigId

    string

    The ID of the health check configuration.

    hra**a

    Examples

    Success response

    JSON format

    {
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD5799335**B",
  "AddrPoolId": "hrbv**",
  "MonitorConfigId": "hra**a"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 DnsGtmSystemBusyness

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.