Creating a Private Zone

Function

This API is used to create a private 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 to be created
description	No	String	Zone description
zone_type	Yes	String	Zone type. The value is private.
email	No	String	Email address of the administrator managing the zone
ttl	No	Integer	Caching duration of the SOA record set (in seconds)
router	Yes	Router object	VPC to be disassociated
proxy_pattern	No	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.
tags	No	Array of tag objects	Resource tag
enterprise_project_id	No	String	ID of the enterprise project associated with the zone. The value contains a maximum of 36 characters. The default value is 0.

**Table 3** Router
Parameter	Mandatory	Type	Description
router_id	Yes	String	ID of the VPC associated with the zone
router_region	No	String	Region of the VPC
status	No	String	Resource status

**Table 4** 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 5** 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. This parameter is reserved.
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. 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.
masters	Array of strings	Master DNS servers, from which the slave servers get DNS information
router	RouterWithStatus object	List of VPC associated with the zone

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

**Table 7** 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 8** 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 9** 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 10** 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 private zone and setting the recursive resolution proxy mode to AUTHORITY for subdomains

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

{
  "name" : "example.com.",
  "description" : "This is an example zone.",
  "zone_type" : "private",
  "email" : "xx@example.org",
  "router" : {
    "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558",
    "router_region" : "xx"
  },
  "proxy_pattern" : "AUTHORITY",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  } ]
}

Example Responses

Status code: 202

Response to the request for creating a private zone

{
  "id" : "ff8080825b8fc86c015b94bc6f8712c3",
  "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/ff8080825b8fc86c015b94bc6f8712c3"
  },
  "pool_id" : "ff8080825ab738f4015ab7513298010e",
  "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
  "zone_type" : "private",
  "created_at" : "2017-04-22T08:17:08.997",
  "updated_at" : null,
  "record_num" : 0,
  "proxy_pattern" : "AUTHORITY",
  "router" : {
    "status" : "PENDING_CREATE",
    "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558",
    "router_region" : "xx"
  }
}