All Products
Search
Document Center

Alibaba Cloud DNS:CreateCloudGtmAddressPool

Last Updated:Apr 21, 2025

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:
    • 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:CreateCloudGtmAddressPoolcreate
*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
AddressPoolNamestringNo

Address pool name, helping users distinguish the purpose of address pools.

Address pool-1
AddressPoolTypestringNo

The type of the address pool. Valid values:

  • IPv4: IPv4 addresses are returned for Domain Name System (DNS) resolution.
  • IPv6: IPv6 addresses are returned for DNS resolution.
  • domain: Domain names are returned for DNS resolution.
IPv4
HealthJudgementstringNo

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
EnableStatusstringNo

The enabling state of the address pool. Valid values:

  • enable: The address pool is enabled, and the addresses in the address pool are returned for DNS resolution when the health check results are normal.
  • disable: The address pool is disabled, and the addresses in the address pool are not returned for DNS resolution regardless of whether the health check results are normal or not.
enable
RemarkstringNo

Remarks for the address pool, helping users distinguish the usage scenarios of different address pools.

app

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Unique request identification code.

46973D4C-E3E4-4ABA-9190-9A9DE406C7E
Successboolean

Indicates whether the address pool creation operation was successful:

  • true: Operation was successful
  • false: Operation was failed
true
AddressPoolIdstring

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

pool-89528023225442**16

Examples

Sample success responses

JSONformat

{
  "RequestId": "46973D4C-E3E4-4ABA-9190-9A9DE406C7E",
  "Success": true,
  "AddressPoolId": "pool-89528023225442**16"
}

Error codes

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