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

update

*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 (default): English	en-US
ClientToken	string	No	A client-generated token that is used to ensure the idempotence of the request. The token must be unique for each request and can contain up to 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
AddressPoolId	string	No	The unique ID of the address pool.	pool-89528023225442****
AddressLbStrategy	string	No	The load balancing policy for the addresses in the address pool. round_robin: Round robin. For each DNS query, all addresses are returned in a rotating order. sequence: Sequence. The address with the highest priority is returned. Priority is determined by the ordinal number of an address. A smaller ordinal number indicates a higher priority. If an address is unavailable, the address with the next highest priority is returned. weight: Weight. DNS queries are resolved based on the weight that you set for each address. source_nearest: Source nearest. This is an intelligent DNS resolution feature. GTM returns an address based on the source of the DNS query. This directs users to the nearest resource.	sequence
SequenceLbStrategyMode	string	No	The recovery mode when the load balancing policy is `sequence`. preemptive: Preemptive mode. If a higher-priority address recovers, it is used preferentially. non_preemptive: Non-preemptive mode. If a higher-priority address recovers, the current address continues to be used.	preemptive

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	B57C121B-A45F-44D8-A9B2-13E5A5044195
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
AddressPoolId	string	The unique ID of the address pool.	pool-89528023225442****

Examples

Success response

JSON format

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "Success": true,
  "AddressPoolId": "pool-89528023225442****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.