All Products
Search
Document Center

Alibaba Cloud DNS:UpdateCloudGtmAddressManualAvailableStatus

Last Updated:Apr 21, 2025

Modifies the failover mode that is used when address exceptions are identified.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:UpdateCloudGtmAddressManualAvailableStatusupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh-CN: Chinese
  • en-US (default): English
en-US
ClientTokenstringNo

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
AddressIdstringYes

The ID of the address. This ID uniquely identifies the address.

addr-89518218114368**92
AvailableModestringNo

The failover mode that is used when address exceptions are identified. Valid values:

  • auto: the automatic mode. The system determines whether to return an address based on health check results. If the address fails health checks, the system does not return the address. If the address passes health checks, the system returns the address.
  • manual: the manual mode. If an address is in the unavailable state, the address is not returned for DNS requests even if the address passes health checks. If an address is in the available state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks.
manual
ManualAvailableStatusstringNo

The availability state of the address when AvailableMode is set to manual. Valid values:

  • available: The address is normal. In this state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks.
  • unavailable: The address is abnormal. In this state, the address is not returned for DNS requests even if the address passes health checks.
available

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Unique request identification code.

0F32959D-417B-4D66-8463-68606605E3E2
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "0F32959D-417B-4D66-8463-68606605E3E2",
  "Success": true
}

Error codes

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