Modifying a Private Zone

Function

This API is used to modify a private zone.

Calling Method

For details, see Calling APIs.

URI

PATCH /v2/zones/{zone_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
zone_id	Yes	String	ID of the zone to be modified

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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	Zone description. A maximum of 255 characters are allowed.
email	No	String	Email address of the administrator managing the zone
ttl	No	Integer	Caching duration of the SOA record set (in seconds)

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 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, which 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
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	Master DNS servers, from which the slave servers get DNS information
routers	Array of RouterWithStatus objects	Information about the VPC associated with the private zone

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

**Table 6** 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 7** 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 8** 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 9** Response body parameters
Parameter	Type	Description
code	String	Error code Minimum: 8 Maximum: 36
message	String	Description Minimum: 2 Maximum: 512

Example Requests

Modifying the email address and description of a private zone and setting the TTL to 300s

PATCH https://v2/zones/{zone_id}

{
  "description" : "This is an example zone.",
  "email" : "xx@example.org",
  "ttl" : 300
}

Example Responses

Status code: 202

Response to the request for modifying a private zone

{
  "id" : "ff8080825b8fc86c015b94bc6f8712c3",
  "name" : "example.com.",
  "description" : "This is an example zone.",
  "email" : "xx@example.com",
  "ttl" : 300,
  "serial" : 1,
  "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:10.849",
  "record_num" : 2,
  "routers" : [ {
    "status" : "ACTIVE",
    "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558",
    "router_region" : "xx"
  } ]
}