CreateCloudGtmAddressPool - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

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:CreateCloudGtmAddressPool

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN: Chinese. en-US: English. This is the default value.	en-US
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a unique token for each request. The token can be up to 64 ASCII characters in length.	1ae05db4-10e7-11ef-b126-00163e24****
AddressPoolName	string	No	The name of the address pool. The name helps you identify the purpose of the address pool.	Address pool-1
AddressPoolType	string	No	The type of the address pool. Valid values: IPv4: The endpoint is an IPv4 address. IPv6: The endpoint is an IPv6 address. domain: The endpoint is a domain name.	IPv4
HealthJudgement	string	No	The health status condition of the address pool. Valid values: any_ok: At least one address in the address pool is active. p30_ok: At least 30% of the addresses in the address pool are active. p50_ok: At least 50% of the addresses in the address pool are active. p70_ok: At least 70% of the addresses in the address pool are active. all_ok: All addresses in the address pool are active.	any_ok
EnableStatus	string	No	The status of the address pool. Valid values: enable: The address pool is enabled and can be used for DNS resolution if it passes health checks. disable: The address pool is disabled and cannot be used for DNS resolution, regardless of its health check status.	enable
Remark	string	No	Remarks about the address pool. The remarks help you identify the scenario in which the address pool is used.	app

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	46973D4C-E3E4-4ABA-9190-9A9DE406C7E
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true
AddressPoolId	string	The unique ID of the address pool.	pool-89528023225442****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.