UpdateCloudGtmAddressPoolEnableStatus - Alibaba Cloud DNS

Modifies the enabling status of an address pool.

Operation description

If an address pool is enabled and the health status of the address pool is Normal, the availability status of the address pool is Available.
If an address pool is disabled or the health status of the address pool is Abnormal, the availability status of the address pool is unavailable.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:UpdateCloudGtmAddressPoolEnableStatus	update	All Resources ``	none	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	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
AddressPoolId	string	No	The ID of the address pool. This ID uniquely identifies the address pool.	pool-89528023225442**16
EnableStatus	string	No	The enabling state of the address pool. Valid values: enable: The address pool is enabled, and the addresses in the address pool are returned for DNS resolution when the health check results are normal. disable: The address pool is disabled, and the addresses in the address pool are not returned for DNS resolution regardless of whether the health check results are normal or not.	enable

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Unique request identification code.	89184F33-48A1-4401-9C0F-40E45DB091AB
Success	boolean	Indicates whether the modification operation was successful: true: Operation was successful false: Operation failed	true
AddressPoolId	string	The ID of the address pool. This ID uniquely identifies the address pool.	pool-89528023225442**16

Examples

Sample success responses

JSONformat

{
  "RequestId": "89184F33-48A1-4401-9C0F-40E45DB091AB",
  "Success": true,
  "AddressPoolId": "pool-89528023225442**16"
}

Error codes

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