UpdateCloudGtmInstanceConfigEnableStatus - Alibaba Cloud DNS

Operation description

If a domain name is enabled and its health status is Normal, the service associated with the access domain name is active.
If a domain name is disabled or its health status is abnormal, the service associated with the access domain name is unavailable.

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

update

*GtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

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.	zh-CN
ClientToken	string	No	A client-generated token that is used to ensure the idempotence of the request. The token must be unique among different requests and can contain a maximum of 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
InstanceId	string	No	The ID of the GTM 3.0 instance that you want to modify.	gtm-cn-wwo3a3h****
ConfigId	string	No	The ID of the domain name instance configuration. For the same access domain name and GTM instance, you can configure both A and AAAA records. This results in two domain name instance configurations for the GTM instance. The ConfigId uniquely identifies a specific configuration. Call the ListCloudGtmInstanceConfigs operation to query the ConfigId of a domain name instance.	Config-000****
EnableStatus	string	No	The enablement status of the domain name instance. Valid values: enable: Enables the domain name instance. disable: Disables the domain name instance.	enable

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	29D0F8F8-5499-4F6C-9FDC-1EE13BF55925
Success	boolean	Indicates whether the operation is successful. Valid values: true: The operation is successful. false: The operation failed.	true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.