Querying Private Zones

Function

This API is used to query private zones.

Calling Method

For details, see Calling APIs.

URI

GET /v2/zones

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Zone type. The value is private. Default: private
limit	No	Integer	Number of resources on each page. The value ranges from 0 to 500. Commonly used values are 10, 20, and 50, and the default value is 500.
marker	No	String	Start resource ID at the beginning for paging query. If the parameter is left blank, only resources on the first page are queried. This parameter is left empty by default.
offset	No	Integer	Start offset of the pagination query. The query will start from the next resource of the offset value. The value ranges from 0 to 2147483647. The default value is 0. If marker is not left blank, the query starts from the resource specified by marker.
tags	No	String	Resource tag
name	No	String	Zone name
status	No	String	Resource status
search_mode	No	String	Search mode. The options are as follows: like: fuzzy search equal: exact search
enterprise_project_id	No	String	ID of the enterprise project associated with the zone. The value contains a maximum of 36 characters. It is set to 0 by default.

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
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.
metadata	metadata object	Number of resources that meet the query condition
zones	Array of PrivateZoneResp objects	Zone list

**Table 4** metadata
Parameter	Type	Description
total_count	Integer	Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

**Table 5** PrivateZoneResp
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
proxy_pattern	String	Recursive resolution proxy mode for subdomain names of private zones. Value options: AUTHORITY: Recursive resolution is not performed for this zone. RECURSIVE: Enable the recursive resolution proxy.
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
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.
tags	Array of tag objects	Resource tag
masters	Array of strings	Master DNS servers, from which the slave servers get DNS information
routers	Array of RouterWithStatus objects	List of VPCs associated with the zone
enterprise_project_id	String	ID of the enterprise project associated with the zone. The value contains a maximum of 36 characters.

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

**Table 7** tag
Parameter	Type	Description
key	String	Tag key. A key can contain up to 36 Unicode characters. It cannot be left blank. A tag value cannot contain special characters (=*<>,\|/) or start or end with spaces.
value	String	Tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. A tag value cannot contain special characters (=*<>,\|/) or start or end with spaces.

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

Status code: 400

**Table 9** 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 10** 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 11** 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 private zones

{
  "links" : {
    "self" : "https://Endpoint/v2/zones?type=private&limit=10",
    "next" : "https://Endpoint/v2/zones?type=private&limit=10&marker=ff8080825b8fc86c015b94bc6f8712c3"
  },
  "zones" : [ {
    "id" : "ff8080825b8fc86c015b94bc6f8712c3",
    "name" : "example.com.",
    "description" : "This is an example zone.",
    "email" : "xx@example.com",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "tags" : [ ],
    "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",
    "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"
    } ],
    "enterprise_project_id" : 0
  }, {
    "id" : "ff8080825b95142f015b951f87280029",
    "name" : "example.org.",
    "description" : "This is an example zone.",
    "email" : "xx@example.org",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "tags" : [ ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/ff8080825b95142f015b951f87280029"
    },
    "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",
    "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"
    } ],
    "enterprise_project_id" : 0
  } ],
  "metadata" : {
    "total_count" : 2
  }
}