Querying a Private Zone

Function

This API is used to query a private zone.

Calling Method

For details, see Calling APIs.

URI

GET /v2/zones/{zone_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
zone_id	Yes	String	Zone ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
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. The value is private.
ttl	Integer	TTL value of the SOA record set in the zone
serial	Integer	Sequence number used to identify zone file changes in the SOA record set of the zone. The sequence number is used for synchronization between the master and slave nodes.
status	String	Resource status
record_num	Integer	Number of record sets in the zone
pool_id	String	Pool that hosts the zone. The pool is assigned by the system.
project_id	String	Project ID of the zone
created_at	String	Time when the zone was created
updated_at	String	Time when the zone was updated
links	pageLink object	Link of the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results.
masters	Array of strings	Primary DNS servers, from which the secondary DNS servers get DNS information
routers	Array of Router objects	VPCs associated with the zone
proxy_pattern	String	Recursive resolution proxy mode for subdomain names of private zones. The options are as follows: AUTHORITY: Recursive resolution is not performed for this zone. RECURSIVE: Enable the recursive resolution proxy.
enterprise_project_id	String	ID of the enterprise project associated with the zone. The value contains a maximum of 36 characters.

**Table 4** pageLink
Parameter	Type	Description
self	String	Link to the current resource
next	String	Link to the next page

**Table 5** Router
Parameter	Type	Description
router_id	String	ID of the VPC associated with the zone
router_region	String	Region of the VPC
status	String	Resource status

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Error code Minimum: 8 Maximum: 36
message	String	Description Minimum: 2 Maximum: 512

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Error code Minimum: 8 Maximum: 36
message	String	Description Minimum: 2 Maximum: 512

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
code	String	Error code Minimum: 8 Maximum: 36
message	String	Description Minimum: 2 Maximum: 512

Example Requests

None

Example Responses

Status code: 200

Response to the request for querying a private zone

{
  "id" : "ff8080825b8fc86c015b94bc6f8712c3",
  "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/ff8080825b8fc86c015b94bc6f8712c3"
  },
  "pool_id" : "ff8080825ab738f4015ab7513298010e",
  "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
  "zone_type" : "private",
  "created_at" : "2017-04-22T08:17:08.997",
  "updated_at" : "2017-04-22T08:17:09.997",
  "record_num" : 2,
  "proxy_pattern" : "AUTHORITY",
  "enterprise_project_id" : "0",
  "routers" : [ {
    "status" : "ACTIVE",
    "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558",
    "router_region" : "xx"
  }, {
    "status" : "ACTIVE",
    "router_id" : "f0791650-db8c-4a20-8a44-a06c6e24b15b",
    "router_region" : "xx"
  } ]
}