ReplaceCloudGtmInstanceConfigAddressPool - Alibaba Cloud DNS

Replaces the address pools associated with an instance.

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 of the response. Valid values: zh-CN: Chinese en-US (default): English	en-US
ClientToken	string	No	A client-generated token that you use to ensure the idempotence of the request. Make sure that the token is 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 GTM 3.0 instance for which you want to replace address pools.	gtm-cn-wwo3a3hb****
AddressPools	array<object>	No	A list of address pools.
	object	No	The information about an address pool.
AddressPoolId	string	No	The unique ID of the address pool. If you specify this parameter, the existing address pools associated with the target instance are deleted and replaced with the address pools that you specify. If you leave this parameter empty, all address pools associated with the target instance are deleted.	pool-89564542105737****
WeightValue	integer	No	The weight of the address pool. Valid values are integers from 1 to 100. You can set a different weight for each address pool. DNS queries are resolved based on the specified weights. This parameter takes effect for the updated address pools.	1
SerialNumber	integer	No	The ordinal number. For DNS requests from any source, address pools with smaller ordinal numbers are returned first. A smaller ordinal number indicates a higher priority. This parameter takes effect for the updated address pools.	1
RequestSource	array	No	A list of request sources.
	string	No	The request source. GTM schedules traffic based on the egress IP address of the local DNS server that a user uses. If the local DNS server supports Extension Mechanisms for DNS (EDNS) client subnet (ECS), GTM can also schedule traffic based on the IP address of the user. This parameter takes effect for the updated address pools.	["default"]
ConfigId	string	No	The ID of the instance configuration. For the same access domain name and GTM instance, you can configure both A and AAAA records. In this case, the GTM instance has two instance configurations. The ConfigId parameter uniquely identifies an instance configuration. Call the ListCloudGtmInstanceConfigs operation to query the ConfigId of the instance configuration.	Config-000****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
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": "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.