Querying a Public Zone¶
Function¶
Query a public zone.
URI¶
GET /v2/zones/{zone_id}
For details, see Table 1.
Parameter | Mandatory | Type | Description |
|---|---|---|---|
zone_id | Yes | String | Zone ID You can obtain the value by calling the API in Querying Public Zones. |
Request¶
Request parameters
None
Example request
Query the zone whose ID is 2c9eb155587194ec01587224c9f90149:
GET https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149
Response¶
Parameter description
Table 2 Parameters in the response¶ Parameter
Type
Description
id
String
Zone ID, which is a UUID used to identify the zone
name
String
Zone name
description
String
Zone description
email
String
Email address of the administrator managing the zone
zone_type
String
Zone type, which can be public or private
ttl
Integer
TTL value of the SOA record set in the zone
The value ranges from 1 to 2147483647.
The default value is 300.
serial
Integer
Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server
This parameter is not used currently.
status
String
Resource status
For details, see Resource Status.
record_num
Integer
Number of record sets in the zone
pool_id
String
Pool ID of the zone, which is assigned by the system
project_id
String
Project ID of the zone
created_at
String
Time when the zone was created
The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.
updated_at
String
Time when the zone was updated
The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.
links
Object
Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results.
For details, see Table 3.
masters
Array of strings
Master DNS servers, from which the slave servers get DNS information
This parameter is not used currently.
Table 3 Description of the links field¶ Parameter
Type
Description
self
String
Link to the current resource
next
String
Link to the next page
Example response
{ "id": "2c9eb155587194ec01587224c9f90149", "name": "example.com.", "description": "This is an example zone.", "email": "xx@example.com", "ttl": 300, "serial": 0, "masters": [], "status": "ACTIVE", "links": { "self": "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149" }, "pool_id": "00000000570e54ee01570e9939b20019", "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c", "zone_type": "public", "created_at": "2016-11-17T11:56:03.439", "updated_at": "2016-11-17T11:56:05.528", "record_num": 2 }
Returned Value¶
If a 2xx status code is returned, for example, 200, 202, or 204, the request is successful.
For details, see Status Code.