You can call this operation to query the list of private zones.


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 DescribeZones

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

Keyword String No test

The keyword that is used to query private zones. 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: 100. Default value: 20.

QueryRegionId String No cn-hangzhou

The ID of the region.

QueryVpcId String No vpc-xxxxx

The ID of the Virtual Private Cloud (VPC).

ResourceGroupId String No rg-xxxxx

The ID of the resource group.

SearchMode String No LIKE

The search mode used to query private zones. Valid values:

  • LIKE: fuzzy search.
  • EXACT: exact search. Default value: EXACT.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 20

The number of entries returned per page.

RequestId String 6856BCF6-11D6-4D7E-AC53-FD579933522B

The ID of the request.

TotalItems Integer 3

The total number of entries.

TotalPages Intege 3

The total number of pages.

Zones Array

The list of private zones.


The information about a private zone.

CreateTime String 2017-12-28T13:08Z

The time when the private zone was created.

CreateTimestamp Long 1514466483000

The timestamp when the private zone was created.

IsPtr Boolean true
  • Indicates whether the private zone is a reverse lookup zone. Valid values:
  • true:yes. false: no.
ProxyPattern String ZONE
  • Indicates whether recursive resolution is performed when a queried subdomain name is not recorded in the private zone. Valid values: ZONE: no
  • RECORD: yes
RecordCount Integer 2

The number of DNS records.

Remark String test

The description of the private zone.

UpdateTime String 2018-01-03T08:57Z

The time when the private zone was updated.

UpdateTimestamp Long 1514969843000

The timestamp when the private zone was updated.

ZoneId String ICAgICAgI_24

The ID of the private zone.

ZoneName String

The name of the private zone.


Sample requests

http(s):// Action=DescribeZones&<Common request parameters>

Sample success responses

XML format

<DescribeZonesResponse>    <PageNumber>1</PageNumber>    <PageSize>20</PageSize>    <RequestId>42532529-0608-4B9B-81EC-BFA995B1AC2C</RequestId>    <TotalItems>22</TotalItems>    <TotalPages>2</TotalPages>    <Zones>    <Zone>    <ZoneName></ZoneName>    <IsPtr>false</IsPtr>    <CreateTimestamp>1516677356000</CreateTimestamp>    <RecordCount>2</RecordCount>    <UpdateTimestamp>1516775741000</UpdateTimestamp>    <CreateTime>2018-01-23T03:15Z</CreateTime>    <UpdateTime>2018-01-24T06:35Z</UpdateTime>    <ZoneId>AgIDE0OQ_149</ZoneId>    <Remark>specialZone</Remark>    </Zone>    <Zone>    <ZoneName>walpole.test</ZoneName>    <IsPtr>false</IsPtr>    <CreateTimestamp>1516635773000</CreateTimestamp>    <RecordCount>3</RecordCount>    <UpdateTimestamp>1516637934000</UpdateTimestamp>    <CreateTime>2018-01-22T15:42Z</CreateTime>    <UpdateTime>2018-01-22T16:18Z</UpdateTime>    <ZoneId>AgIDE0OA_148</ZoneId>    </Zone>    <Zone>    <ZoneName></ZoneName>    <IsPtr>false</IsPtr>    <CreateTimestamp>1516616030000</CreateTimestamp>    <RecordCount>2</RecordCount>    <UpdateTimestamp>1516622372000</UpdateTimestamp>    <CreateTime>2018-01-22T10:13Z</CreateTime>    <UpdateTime>2018-01-22T11:59Z</UpdateTime>    <ZoneId>AgIDE0Nw_147</ZoneId>    <Remark>abc</Remark>    </Zone>    </Zones></DescribeZonesResponse>

JSON format


Error codes

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