ReplaceCloudGtmAddressPoolAddress - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Replaces the addresses in a specified address pool.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The response language. Valid values: zh-CN: Chinese en-US (Default): English	en-US
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Ensure the client token is unique for each request. The token can contain a maximum of 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
AddressPoolId	string	No	The unique ID of the address pool to update.	pool-89618921167339****
Addresses	array<object>	No	The list of addresses.
	object	No	The address information.
AddressId	string	No	The unique ID of the address. If you specify this parameter, all existing addresses in the address pool are deleted and replaced with the specified addresses. If you leave this parameter empty, all existing addresses in the address pool are deleted.	addr-89636516932803****
WeightValue	integer	No	The weight of the address. Valid values: 1 to 100. You can set a different weight for each address. DNS queries are then resolved based on the weight ratio. This setting applies to the updated addresses.	1
SerialNumber	integer	No	The serial number, which determines the priority of the address. A smaller number indicates a higher priority. This setting applies to the updated addresses.	1
RequestSource	array	No	The list of DNS request sources.
	string	No	The source of the DNS request. Global Traffic Manager (GTM) schedules traffic based on the egress IP address of the local DNS server that the client uses. If the local DNS server supports Extension Mechanisms for DNS (EDNS) client subnet (ECS), GTM can also perform intelligent scheduling based on the client's IP address. This setting applies to the updated addresses.	["default"]

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	B57C121B-A45F-44D8-A9B2-13E5A5044195
Success	boolean	Indicates whether the operation was successful. true: The operation was successful. false: The operation failed.	true
AddressPoolId	string	The unique ID of the address pool.	pool-89618921167339****

Examples

Success response

JSON format

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "Success": true,
  "AddressPoolId": "pool-89618921167339****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.