All Products
Search
Document Center

Alibaba Cloud DNS:ReplaceCloudGtmInstanceConfigAddressPool

Last Updated:Apr 21, 2025

Replaces address pools that are associated with a GTM instance with new address pools.

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
alidns:ReplaceCloudGtmInstanceConfigAddressPoolupdate
*GtmInstance
acs:alidns::{#accountId}:gtminstance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AcceptLanguagestringNo

The language of the response. 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 change address pools.

gtm-cn-wwo3a3hbz**
AddressPoolsarray<object>No

The address pools.

AddressPoolobjectNo

The address pool.

AddressPoolIdstringNo

The ID of the address pool. This ID uniquely identifies the address pool.

  • If you specify this parameter, the address pools that are associated with the desired instance are removed and the instance is associated with new address pools.
  • If this parameter is left empty, the address pools that are associated with the desired instance are removed and no address pool is associated with the instance.
pool-89564542105737**12
WeightValueintegerNo

The weight value of the new address pool. You can set a different weight value for each address pool. This way, address pools are returned based on the weight values for Domain Name System (DNS) requests. A weight value must be an integer that ranges from 1 to 100.

1
SerialNumberintegerNo

The sequence number of the new address pool. The address pool with the smallest sequence number is preferentially returned for DNS requests from any source. The sequence number specifies the priority for returning the address pool. A smaller sequence number specifies a higher priority.

1
RequestSourcearrayNo

The DNS request sources.

stringNo

The DNS request source. GTM schedules DNS requests based on the egress IP addresses of the local DNS servers used by clients. If the local DNS server used by a client supports EDNS Client Subnet (ECS), GTM can also perform intelligent scheduling based on the IP address of the client. The configuration parameter takes effect on the new address pool.

["default"]
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 access domain name.

Config-000**11

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Unique request identification code.

536E9CAD-DB30-4647-AC87-AA5CC38C5382
Successboolean

Indicates whether the operation was successful, with values:

  • true: Success.
  • false: Failure.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history