Creating a Public Zone

Function

This API is used to create a public zone.

Calling Method

For details, see Calling APIs.

URI

POST /v2/zones

Request Parameters

**Table 1** 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.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Zone name
description	No	String	Description
zone_type	No	String	Zone type. The value is public.
email	No	String	Mailbox of the administrator managing the zone
ttl	No	Integer	Caching duration of the SOA record set generated by default, in seconds
enterprise_project_id	No	String	ID of the enterprise project associated with the domain name. The value contains a maximum of 36 characters.
tags	No	Array of tag objects	Resource tag

**Table 3** tag
Parameter	Mandatory	Type	Description
key	Yes	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	No	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.

Response Parameters

Status code: 202

**Table 4** 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 public.
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 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 YYYY-MM-DDTHH:MM:SSZ.
updated_at	String	Time when the zone was updated. The UTC time format is YYYY-MM-DDTHH:MM:SSZ.
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.
enterprise_project_id	String	ID of the enterprise project associated with the zone. The value contains a maximum of 36 characters.
masters	Array of strings	Master DNS servers, from which the slave servers get DNS information. This parameter is reserved.

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

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: 500

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

Example Requests

Creating a public zone with the TTL set to 300s

POST https://{endpoint}/v2/zones

{
  "name" : "example.com.",
  "description" : "This is an example zone.",
  "zone_type" : "public",
  "email" : "xx@example.org",
  "ttl" : 300,
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  } ]
}

Example Responses

Status code: 202

Response to the request for creating a public zone

{
  "id" : "2c9eb155587194ec01587224c9f90149",
  "name" : "example.com.",
  "description" : "This is an example zone.",
  "email" : "xx@example.com",
  "ttl" : 300,
  "serial" : 1,
  "masters" : [ ],
  "status" : "PENDING_CREATE",
  "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" : null,
  "record_num" : 0
}