Querying the Public Zones

Function

This API is used to query information about all public zones. The information includes the domain name, zone ID, status, number of record sets, enterprise project, tags, TTL, creation time, modification time, and description.

Calling Method

For details, see Calling APIs.

URI

GET /v2/zones

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Definition Zone type Constraints N/A Range public: Public zone Default Value public
limit	No	Integer	Definition The number of records returned on each page during pagination query. Constraints N/A Range 0 to 500 Default Value 500
marker	No	String	Definition The resource ID from which the next page of data should begin in pagination query. When querying the first page, leave this parameter empty. When querying the next page, set this parameter to the ID of the last resource on the previous page. Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition The offset of pagination query. It specifies the number of rows or records to skip from the beginning of the result set before retrieving the desired data. Constraints If marker is not left blank, the query starts from the resource specified by marker and the offset does not take effect. Range 0 to 2147483647 Default Value 0
tags	No	String	Definition The tags of the public zone, including the tag keys and tag values. Format: key1,value1\|key2,value2. Constraints Multiple tags are separated by vertical bars (\|). The key and value of each tag are separated by a comma (,). The AND operator is used to filter tags. An exact match will be used. - If the tag value starts with &ast, fuzzy matching will work for the string following &ast. Range A maximum of 20 tags can be queried. Default Value N/A
name	No	String	Definition Zone. A fuzzy search will be used by default. Constraints N/A Range N/A Default Value N/A
id	No	String	Definition Zone ID Constraints N/A Range N/A Default Value N/A
status	No	String	Definition The status of the public zone. Constraints N/A Range ACTIVE: The zone is normal. PENDING_CREATE: The zone is being created. PENDING_UPDATE: The zone is being updated. PENDING_DELETE: The zone is being deleted. PENDING_FREEZE: The zone is being frozen. FREEZE: The zone is frozen. ILLEGAL: The zone is frozen due to abuse. POLICE: The zone is frozen due to security reasons. PENDING_DISABLE: The zone is being disabled. DISABLE: The zone is disabled. ERROR: The zone is failed. Default Value N/A
search_mode	No	String	Definition Search mode Constraints N/A Range like: fuzzy search equal: exact search Default Value N/A
sort_key	No	String	Definition The sorting field of zone query results. Constraints N/A Range name: domain name created_at: creation time updated_at: update time Default Value created_at
sort_dir	No	String	Definition The sorting method of zones query results. Constraints N/A Range desc: descending order asc: ascending order Default Value desc
enterprise_project_id	No	String	Definition The ID of the enterprise project to which the zone belongs. This parameter is used to filter the zones under an enterprise project. Constraints N/A Range The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project. Default Value 0

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining a User Token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
links	pageLink object	Definition The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page. Range N/A
zones	Array of PublicZoneResp objects	Definition Response to the request for querying public zones Range N/A
metadata	metadata object	Definition Number of resources that meet the filter condition Range N/A

**Table 4** PublicZoneResp
Parameter	Type	Description
id	String	Definition Zone ID, which is a UUID used to identify the zone Range N/A
name	String	Definition The domain name. Range Enter multiple labels separated by periods (.). Use only letters, digits, and hyphens (-). Do not start or end with a hyphen (-). Max label length: 63 characters. Max total: 254 characters.
description	String	Definition The description of the zone. Range The value can contain a maximum of 255 characters.
email	String	Definition Email address of the administrator who manages the zone. The email address is used to generate the SOA record set of the zone. Range N/A
zone_type	String	Definition Zone type Range public: Public zone
ttl	Integer	Definition The TTL specified in the SOA record in the zone. It is measured in seconds. Range 1 to 2147483647
serial	Integer	Definition 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 primary and secondary nodes. Range N/A
status	String	Definition The status of the public zone. Range ACTIVE: The zone is normal. PENDING_CREATE: The zone is being created. PENDING_UPDATE: The zone is being updated. PENDING_DELETE: The zone is being deleted. PENDING_FREEZE: The zone is being frozen. FREEZE: The zone is frozen. ILLEGAL: The zone is frozen due to abuse. POLICE: The zone is frozen due to security reasons. PENDING_DISABLE: The zone is being disabled. DISABLE: The zone is disabled. ERROR: The zone is failed.
record_num	Integer	Definition Number of record sets for the zone Range N/A
pool_id	String	Definition Pool ID of the zone, which is assigned by the system Range N/A
project_id	String	Definition Project ID of the zone Range N/A
created_at	String	Definition The time when a zone was created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A
updated_at	String	Definition The time when the zone was last modified. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A
links	pageLink object	Definition The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page. Range N/A
tags	Array of tag objects	Definition Resource tag Range N/A
masters	Array of strings	Definition Primary DNS servers, from which the secondary DNS servers get DNS information Range N/A
enterprise_project_id	String	Definition The ID of the enterprise project to which the zone belongs. This parameter is used to filter the zones under an enterprise project. Range The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project.

**Table 5** pageLink
Parameter	Type	Description
self	String	Definition The link to the current page. Range N/A
next	String	Definition The link to the next page. Range N/A

**Table 6** tag
Parameter	Type	Description
key	String	Definition The tag key. Range Cannot be left blank. Must be unique for each resource. Contains up to 128 characters. Cannot start or end with a space, or start with *sys*. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@
value	String	Definition The tag value. Range Can be left blank. Can contain a maximum of 255 characters. Only letters, digits, spaces, and the following special characters are allowed: _.:/=+-@

**Table 7** metadata
Parameter	Type	Description
total_count	Integer	Definition Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. Range N/A

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
code	String	Definition Error code Range N/A
message	String	Definition Error description Range N/A

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
code	String	Definition Error code Range N/A
message	String	Definition Error description Range N/A

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
code	String	Definition Error code Range N/A
message	String	Definition Error description Range N/A

Example Requests

Querying the public zones

GET https://{endpoint}/v2/zones?type=public&limit=10

Example Responses

Status code: 200

Successful request

{
  "links" : {
    "self" : "https://Endpoint/v2/zones?type=public&limit=10",
    "next" : "https://Endpoint/v2/zones?type=public&limit=10&marker=2c9eb155587194ec01587224c9f90149"
  },
  "zones" : [ {
    "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
  }, {
    "id" : "2c9eb155587228570158722996c50001",
    "name" : "example.org.",
    "description" : "This is an example zone.",
    "email" : "xx@example.org",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "status" : "PENDING_CREATE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001"
    },
    "pool_id" : "00000000570e54ee01570e9939b20019",
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "zone_type" : "public",
    "created_at" : "2016-11-17T12:01:17.996",
    "updated_at" : "2016-11-17T12:01:18.528",
    "record_num" : 2
  } ],
  "metadata" : {
    "total_count" : 2
  }
}