All Products
Search

This Product

    Alibaba Cloud DNS:AddGtmAddressPool

    Document Center

    Alibaba Cloud DNS:AddGtmAddressPool

    Last Updated:Dec 02, 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:AddGtmAddressPool

    create

    *gtminstance

    acs:alidns::{#accountId}:gtminstance/{#gtminstanceId}

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    Lang

    string

    No

    The response language.

    en

    InstanceId

    string

    Yes

    The instance ID.

    gtm-cn-xxxxxxx

    Name

    string

    Yes

    The name of the address pool.

    Test

    Type

    string

    Yes

    The type of the address pool. Valid values:

    • IP: IPv4 address

    • DOMAIN: domain name

    IP

    MinAvailableAddrNum

    integer

    Yes

    The minimum number of available addresses.

    1

    MonitorStatus

    string

    No

    The status of the health check. Valid values:

    • OPEN: enabled

    • CLOSE (default): 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. The value must be 60.

    60

    EvaluationCount

    integer

    No

    The number of consecutive failed health checks.

    2

    Timeout

    integer

    No

    The timeout period. Unit: milliseconds. Valid values: 2000, 3000, 5000, and 10000.

    5000

    MonitorExtendInfo

    string

    No

    The extended information. The parameters that you must configure vary based on the health check protocol.

    HTTP and HTTPS:

    • port: The health check port.

    • failureRate: The failure rate.

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

    • host: The host setting.

    • path: The URL path.

    PING:

    • packetNum: The number of ping packets.

    • packetLossRate: The packet loss rate.

    • failureRate: The failure rate.

    TCP:

    • port: The health check port.

    • failureRate: The failure rate.

    {"host":"aliyun.com","port":80}

    Addr

    array<object>

    Yes

    The list of addresses in the address pool.

    object

    No

    Value

    string

    No

    The address.

    1.1.XX.XX

    LbaWeight

    integer

    No

    The weight of the address.

    1

    Mode

    string

    No

    The mode of the address. Valid values:

    • SMART: smart return

    • ONLINE: always online

    • OFFLINE: always offline

    SMART

    IspCityNode

    array<object>

    No

    The list of city nodes for monitoring.

    object

    No

    CityCode

    string

    No

    The city code of the monitoring node. For information about valid values, see the response of DescribeGtmMonitorAvailableConfig.

    546

    IspCode

    string

    No

    • For information about valid values, see the response of DescribeGtmMonitorAvailableConfig.

    • If GroupType is set to Border Gateway Protocol (BGP) or Overseas, IspCityNode.N.IspCode is optional. The default value is 465.

    • If GroupType is not set to BGP or Overseas, IspCityNode.N.IspCode is required and must be used with IspCityNode.N.CityCode.

    465

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The unique request ID.

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

    AddrPoolId

    string

    The ID of the address pool.

    hraf3x

    MonitorConfigId

    string

    The ID of the health check configuration.

    hraf14

    Examples

    Success response

    JSON format

    {
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "AddrPoolId": "hraf3x",
  "MonitorConfigId": "hraf14"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.