All Products
Search
Document Center

Alibaba Cloud DNS:UpdateCloudGtmAddressPoolBasicConfig

Last Updated:Sep 09, 2025

Modifies the basic configuration of 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:UpdateCloudGtmAddressPoolBasicConfig

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

AcceptLanguage

string

No

The language of the response. Valid values:

  • zh-CN: Chinese

  • en-US (default): English

en-US

ClientToken

string

No

The client token that is used to ensure the idempotence of the request. The client generates this token to make sure that each request is unique. The token can contain a maximum of 64 ASCII characters.

1ae05db4-10e7-11ef-b126-00163e24****

AddressPoolId

string

No

The unique ID of the address pool.

pool-89528023225442****

AddressPoolName

string

No

The name of the address pool.

app

HealthJudgement

string

No

The condition for determining the health status of the address pool.

  • 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

Response elements

Element

Type

Description

Example

object

RequestId

string

The unique request ID.

536E9CAD-DB30-4647-AC87-AA5CC38C5382

Success

boolean

Indicates whether the basic configuration of the address pool was modified.

  • 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": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "Success": true,
  "AddressPoolId": "pool-89528023225442****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.