UpdateCloudGtmInstanceConfigLbStrategy

Updated at: 2025-03-18 06:57

Modifies the load balancing policy of a Global Traffic Manager (GTM) 3.0 instance.

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
OperationAccess levelResource typeCondition keyAssociated operation
alidns:UpdateCloudGtmInstanceConfigLbStrategyupdate
*GtmInstance
acs:alidns::{#accountId}:gtminstance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
AcceptLanguagestringNo

The language in which the returned results are displayed. 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
InstanceIdstringNo

The ID of the GTM 3.0 instance for which you want to modify the load balancing policy.

gtm-cn-wwo3a3hbz**
ConfigIdstringNo

The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.

You can call the ListCloudGtmInstanceConfigs operation to query the configuration ID of the desired access domain name.

Config-000**11
AddressPoolLbStrategystringNo

The new policy for load balancing between address pools. Valid values:

  • round_robin: All address pools are returned for Domain Name System (DNS) requests from any source. All address pools are sorted in round-robin mode each time they are returned.
  • sequence: The address pool with the smallest sequence number is preferentially returned for DNS requests from any source. The sequence number indicates the priority for returning the address pool. A smaller sequence number indicates a higher priority. If the address pool with the smallest sequence number is unavailable, the address pool with the second smallest sequence number is returned.
  • weight: You can set a different weight value for each address pool. This way, address pools are returned based on the weight values.
  • source_nearest: GTM returns different address pools based on the sources of DNS requests. This way, users can access nearby address pools.
sequence
SequenceLbStrategyModestringNo

The mode used if the address pool with the smallest sequence number is recovered. This parameter is required when AddressPoolLbStrategy is set to sequence. Valid values:

  • preemptive: The address pool with the smallest sequence number is preferentially used if this address pool is recovered.
  • non_preemptive: The current address pool is still used even if the address pool with the smallest sequence number is recovered.
preemptive

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
The current API has no return parameters

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
No change history
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare