UpdateCloudGtmAddressEnableStatus - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Modifies the enabling status of an address.

Operation description

If an address is enabled and the health status of the address is Normal, the availability status of the address is Available.
If an address is disabled or the health status of the address is Abnormal, the availability status of the address 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:UpdateCloudGtmAddressEnableStatus	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can specify a custom value for this parameter, 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
AddressId	string	Yes	The ID of the address. This ID uniquely identifies the address.	addr-89518218114368**92
EnableStatus	string	Yes	The enabling state of the address. Valid values: enable: The address is enabled and the address can be used for Domain Name System (DNS) resolution if the address passes health checks. disable: The address is disabled and the address cannot be used for DNS resolution regardless of whether the address passes health checks or not.	enable

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Unique request identification code.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation was failed.	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.