You can call this operation to query the list of Domain Name System (DNS) records.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeZoneRecords

The operation that you want to perform. Set the value to DescribeZoneRecords.

ZoneId String Yes CAgICA1OA_58

The ID of the private zone.

Keyword String No test

The keyword that is used to query DNS records. Specify the keyword in the %Keyword% format. The keyword is case insensitive.

Lang String No en

The language of the specific content returned in the response.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

PageSize Integer No 100

The number of entries to return on each page. Maximum value: 500. Default value: 20.

SearchMode String No LIKE

The search method used to query DNS records. Valid values:

  • LIKE: fuzzy search.
  • EXACT: exact search. Default value: EXACT.
Tag String No tag

The tag used to query DNS records.

UserClientIp String No 1.1.1.1

The IP address of the client.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 100

The number of entries returned per page.

Records Array

The list of DNS records.

Record

The information about a DNS record.

Priority Integer 60

The priority of the MX record. Valid values: 1 to 10.

This parameter is required if the type of the DNS record is MX.

RecordId Long 5809

The ID of the DNS record.

Remark String xxx

The description of the DNS record.

Rr String www

The prefix of the domain or subdomain name.

Status String ENABLE

The status of the DNS record.

Ttl Integer 60

The amount of time that the DNS resolver caches the value of the DNS record. Default value: 60.

Type String A

The type of the DNS record.

Value String 1.1.1.1

The value of the DNS record.

RequestId String 7B07FBC3-3A53-4939-A3C6-2BDFE407BAB2

The ID of the request.

TotalItems Integer 100

The total number of DNS records.

TotalPages Integer 100

The total number of pages.

Examples

Sample requests

http://pvtz.aliyuncs.com/?Action=DescribeZoneRecords&ZoneId=CAgICA1OA_58&<Common request parameters>

Sample success responses

XML format

<DescribeZoneRecordsResponse>    <PageNumber>1</PageNumber>    <Records>    <Record>    <Status>DISABLE</Status>    <Value>1.1.1.1</Value>    <Rr>www</Rr>    <RecordId>5809</RecordId>    <Ttl>60</Ttl>    <Type>A</Type>    </Record>    <Record>    <Status>ENABLE</Status>    <Value>1.1.1.1</Value>    <Rr>a49880308bb2</Rr>    <RecordId>5808</RecordId>    <Ttl>60</Ttl>    <Type>A</Type>    </Record>    </Records>    <PageSize>20</PageSize>    <RequestId>7B07FBC3-3A53-4939-A3C6-2BDFE407BAB2</RequestId>    <TotalItems>2</TotalItems>    <TotalPages>1</TotalPages></DescribeZoneRecordsResponse>

JSON format

{“PageNumber”:1,“Records”:{“Record”:[{“Status”:”DISABLE”,“Rr”:”www”,“Value”:”1.1.1.1”,“RecordId”:5809,“Type”:”A”,“Ttl”:60,},{“Status”:”ENABLE”,“Rr”:”a49880308bb2”,“Value”:”1.1.1.1”,“RecordId”:5808,“Type”:”A”,“Ttl”:60,}]},“PageSize”:20,“RequestId”:”2748A96A-3D47-4B27-AE8B-75C41B16D652”,“TotalItems”:2,“TotalPages”:1,}

Error codes

For a list of error codes, visit the API Error Center.