All Products
Search
Document Center

Alibaba Cloud DNS:UpdateCloudGtmInstanceConfigEnableStatus

Last Updated:Apr 21, 2025

Updates the enabling status of an access domain name based on the specified parameters.

Operation description

  • If an access domain name is enabled and the health state is normal, the access domain name is deemed available.
  • If an access domain name is disabled or the health state is abnormal, the access domain name is deemed 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.

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:UpdateCloudGtmInstanceConfigEnableStatusupdate
*GtmInstance
acs:alidns::{#accountId}:gtminstance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AcceptLanguagestringNo

The language of the response. Valid values:

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

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
InstanceIdstringNo

The ID of the Global Traffic Manager (GTM) 3.0 instance.

gtm-cn-wwo3a3hbz**
ConfigIdstringNo

The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.

You can call the ListCloudGtmInstanceConfigs operation to query the configuration ID of the access domain name.

Config-000**11
EnableStatusstringNo

The enabling state of the access domain name. Valid values:

  • enable
  • disable
enable

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Unique request identification code.

29D0F8F8-5499-4F6C-9FDC-1EE13BF55925
Successboolean

Indicates whether the operation was successful:

  • true: The call succeeded.
  • false: The call failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF55925",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history