DescribeZoneRecord - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the details of a DNS record.

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

get

*Zone

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

None

Request parameters

Parameter	Type	Required	Description	Example
RecordId	integer	Yes	The ID of the DNS record.	5808

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0B7AD377-7E86-44A8-B9A8-53E8666E72FE
Status	string	The status of the DNS record. Valid values: ENABLE: The DNS record is enabled. DISABLE: The DNS record is paused.	ENABLE
Type	string	The type of the DNS record.	A
Value	string	The record value.	127.0.0.1
Ttl	integer	The time to live (TTL).	60
Remark	string	The remarks.	test record
RecordId	integer	The ID of the DNS record.	5808
Rr	string	The host record.	www
Priority	integer	The priority of the mail exchange (MX) record.	5
Line	string	The DNS resolution line.	default
Weight	integer	The weight of the DNS record.	1
CreateTime	string	The time when the record was created.	2018-01-23T03:15Z
UpdateTime	string	The time when the record was last updated.	2018-01-24T06:35Z
CreateTimestamp	integer	The timestamp that indicates when the record was created.	1516775741000
UpdateTimestamp	integer	The timestamp that indicates when the record was last updated.	1516775741000
ZoneId	string	The zone ID.	CAgICA1OA_58

Examples

Success response

JSON format

{
  "RequestId": "0B7AD377-7E86-44A8-B9A8-53E8666E72FE",
  "Status": "ENABLE",
  "Type": "A",
  "Value": "127.0.0.1",
  "Ttl": 60,
  "Remark": "test record",
  "RecordId": 5808,
  "Rr": "www",
  "Priority": 5,
  "Line": "default",
  "Weight": 1,
  "CreateTime": "2018-01-23T03:15Z",
  "UpdateTime": "2018-01-24T06:35Z",
  "CreateTimestamp": 1516775741000,
  "UpdateTimestamp": 1516775741000,
  "ZoneId": "CAgICA1OA_58"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.