SetZoneRecordStatus - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

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

pvtz:SetZoneRecordStatus

update

*Zone

acs:pvtz::{#accountId}:zone/{#ZoneId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese. en: English. The default value is en.	en
RecordId	integer	Yes	The ID of the DNS record.	207541****
Status	string	Yes	The status of the DNS record. Valid values: ENABLE: Enables DNS resolution. DISABLE: Pauses DNS resolution.	ENABLE
UserClientIp	string	No	The client IP address.	127.XX.XX
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. The client generates this value. The value must be unique among different requests and can be up to 64 ASCII characters in length.	6447728c8578e66aacf062d2df4446dc

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the DNS record. Valid values: ENABLE: DNS resolution is enabled. DISABLE: DNS resolution is paused.	ENABLE
RequestId	string	The unique ID of the request.	39CB16E5-4180-49F2-A060-23C0ECEB80D9
RecordId	integer	The ID of the DNS record.	207541****

Examples

Success response

JSON format

{
  "Status": "ENABLE",
  "RequestId": "39CB16E5-4180-49F2-A060-23C0ECEB80D9",
  "RecordId": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.