All Products
Search
Document Center

Alibaba Cloud DNS:UpdateCloudGtmInstanceConfigLbStrategy

Last Updated:Dec 03, 2025

Updates the load balancing policy for an instance configuration.

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

update

*GtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

None 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

A client-generated token that is used to ensure the idempotence of the request. The token must be unique among different requests. The token can contain a maximum of 64 ASCII characters.

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

InstanceId

string

No

The ID of the Global Traffic Manager (GTM) 3.0 instance.

gtm-cn-wwo3a3h***

ConfigId

string

No

The ID of the instance configuration. A GTM instance can have multiple configurations for the same domain name, such as one for A records and another for AAAA records. The ConfigId uniquely identifies the configuration that you want to modify.

For more information, see ListCloudGtmInstanceConfigs.

Config-000****

AddressPoolLbStrategy

string

No

The load balancing policy for the address pools. Valid values:

  • round_robin: Returns all address pools for any DNS request. The address pools are rotated for each request.

  • sequence: Returns the address pool with the smallest ordinal number. The smaller the ordinal number, the higher the priority. If the primary address pool is unavailable, the next address pool in the sequence is used.

  • weight: Distributes DNS requests to address pools based on their configured weights.

  • source_nearest: Returns an address pool based on the proximity of the DNS request source. This implements intelligent DNS resolution and directs users to the nearest access point.

sequence

SequenceLbStrategyMode

string

No

The recovery mode for a primary address pool when the load balancing policy is set to sequence. Valid values:

  • preemptive: The system switches back to the primary address pool as soon as it recovers.

  • non_preemptive: The system continues to use the current address pool even after the primary address pool recovers.

preemptive

Response elements

Element

Type

Description

Example

object

RequestId

string

The unique identifier for the request.

0F32959D-417B-4D66-8463-68606605E3E2

Success

boolean

Indicates whether the operation was successful. Valid values:

  • true: The operation was successful.

  • false: The operation failed.

true

Examples

Success response

JSON format

{
  "RequestId": "0F32959D-417B-4D66-8463-68606605E3E2",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.