All Products
Search

This Product

    Alibaba Cloud DNS:AddDnsGtmAddressPool

    Document Center

    Alibaba Cloud DNS:AddDnsGtmAddressPool

    Last Updated:Oct 11, 2024

    Creates 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:
      • The required resource types are displayed in bold characters.
      • 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:AddDnsGtmAddressPoolcreate
    • gtmInstance
      acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    LangstringNo

    The language of the values of specific response parameters. Default value: en. Valid values: en, zh, and ja.

    		en
    InstanceIdstringYes

    The instance ID.

    		instance1
    NamestringYes

    The name of the address pool.

    		test
    TypestringYes

    The type of the address pool. Valid values:

    • IPV4: IPv4 address
    • IPV6: IPv6 address
    • DOMAIN: domain name
    		ipv4
    LbaStrategystringYes

    The load balancing policy of the address pool. Valid values:

    • ALL_RR: returns all addresses.
    • RATIO: returns addresses by weight.
    		all_rr
    MonitorStatusstringNo

    Specifies whether to enable the health check feature. If you set this parameter to OPEN, the system verifies the health check configurations. If you set this parameter to CLOSE, the system discards the health check configurations. Default value: CLOSE. Valid values:

    • OPEN: enables the health check feature.
    • CLOSE: disables the health check feature.
    		open
    ProtocolTypestringNo

    The health check protocol. Valid values:

    • HTTP
    • HTTPS
    • PING
    • TCP
    		http
    IntervalintegerNo

    The health check interval. Unit: seconds.

    		1
    EvaluationCountintegerNo

    The number of consecutive failures.

    		1
    TimeoutintegerNo

    The timeout period. Unit: milliseconds.

    		1
    MonitorExtendInfostringNo

    The extended information. The required parameters vary based on the health check protocol.

    • HTTP or HTTPS:

      • port: the port that you want to check

      • host: the host settings

      • path: the URL

      • code: the return code. The health check result is deemed abnormal if the returned value is greater than the specified value. Valid values: 400 and 500.

      • failureRate: the failure rate

      • sni: specifies whether to enable Server Name Indication (SNI). This parameter is available only when ProtocolType is set to HTTPS. Valid values:

        • true: enables SNI.
        • other: disables SNI.

      • nodeType: the type of the node for monitoring when Type is set to DOMAIN. Valid values:

        • IPV4
        • IPV6

    • ping:

      • failureRate: the failure rate

      • packetNum: the number of ping packets

      • packetLossRate: the loss rate of ping packets

      • nodeType: the type of the node for monitoring when Type is set to DOMAIN. Valid values:

        • IPV4
        • IPV6

    • TCP:

      • port: the port that you want to check

      • failureRate: the failure rate

      • nodeType: the type of the node for monitoring when Type is set to DOMAIN. Valid values:

        • IPV4
        • IPV6
    		{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
    Addrarray<object>Yes

    The address pools.

    objectYes
    AttributeInfostringYes

    The information about the source region of the address. The value of this parameter is a JSON string. Valid values:

    • lineCode: the line code of the source region for the address

    • lineCodeRectifyType: the rectification type of the line code. Default value: AUTO. Valid values:

      • NO_NEED: no need for rectification
      • RECTIFIED: rectified
      • AUTO: automatic rectification
    		default
    RemarkstringNo

    The description of the address pool.

    		test
    LbaWeightintegerNo

    The weight of the address.

    		1
    AddrstringYes

    The address in the address pool.

    		1.1.1.1
    ModestringYes

    The return mode of the addresses: Valid values:

    • SMART: smart return
    • ONLINE: always online
    • OFFLINE: always offline
    		online
    IspCityNodearray<object>No

    The nodes for monitoring.

    objectNo
    CityCodestringNo

    The city code.

    Specify the parameter according to the value of CityCode returned by the DescribeGtmMonitorAvailableConfig operation.

    		503
    IspCodestringNo
    • The Internet service provider (ISP) node. Specify the parameter according to the value of IspCode returned by the DescribeGtmMonitorAvailableConfig operation.
    • If the returned value of GroupType for the DescribeGtmMonitorAvailableConfig operation is BGP or Overseas, IspCode is not required and is set to 465 by default.
    • If the returned value of GroupType for the DescribeGtmMonitorAvailableConfig operation is not BGP or Overseas, IspCode is required. When IspCode is specified, CityCode is required.
    		465

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

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

    The ID of the address pool.

    		testpool1
    MonitorConfigIdstring

    The ID of the health check configuration.

    		test1

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    400DnsGtmSystemBusyness

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

    Change history

    Change timeSummary of changesOperation
    2023-03-21The Error code has changedView Change Details