ReplaceCloudGtmInstanceConfigAddressPool-阿里云帮助中心

Replaces the address pools associated with an instance based on the specified parameters.

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

update

*GtmInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language in which the response is returned. Valid values: zh-CN: Chinese. en-US: English. This is the default value.	en-US
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The token must be generated by the client and be unique among different requests. The token can be up to 64 ASCII characters in length.	1ae05db4-10e7-11ef-b126-00163e24****
InstanceId	string	No	The instance ID of the Global Traffic Manager (GTM) 3.0 instance for which you want to replace the IPAM pools.	gtm-cn-wwo3a3hb****
AddressPools	array<object>	No	The list of address pools.
	object	No	The address pool information.
AddressPoolId	string	No	The ID of the address pool, which is the unique identifier of the address pool. If this parameter is not empty, the address pools associated with the target instance are deleted and replaced with the updated address pools. If this parameter is empty, all address pools referenced by the target instance are deleted, and the instance is not associated with any address pool.	pool-89564542105737****
WeightValue	integer	No	The weight of the address pool. Valid values: an integer from 1 to 100. You can set different weights for each address pool to return address pools based on the weight ratio for DNS queries. This parameter takes effect on the updated address pools.	1
SerialNumber	integer	No	The sequence number. For DNS queries from any source, the address pool with a smaller sequence number is returned. The sequence number indicates the priority of the address pool. A smaller value indicates a higher priority. This parameter takes effect on the updated address pools.	1
RequestSource	array	No	The list of DNS query sources.
	string	No	The source of the DNS query. GTM schedules traffic based on the egress IP address of the local DNS used by the client. If the local DNS supports EDNS Client Subnet (ECS), intelligent scheduling can also be performed based on the IP address of the client. This parameter takes effect on the updated address pools.	["default"]
ConfigId	string	No	The ID of the domain name instance configuration. You can configure both A and AAAA records for the same domain name and GTM instance. In this case, two domain name instance configurations are generated for the same GTM instance. The ConfigId uniquely identifies a domain name instance configuration. You can call the ListCloudGtmInstanceConfigs operation to query the ConfigId of the domain name instance.	Config-000****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
Success	boolean	Indicates whether the operation is successful. Valid values: true: Successful. false: Failed.	true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.