Setting the Status of a Public Zone

Updated on 2025-01-08 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to set the status of a public zone. You can suspend or enable a zone.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/zones/{zone_id}/statuses

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
zone_id	Yes	String	ID of the zone whose status is to be set

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
status	Yes	String	Record set status. The value can be ENABLE or DISABLE, and the default value is ENABLE. ENABLE means that the record set is enabled. DISABLE means that the record set is disabled.

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 who manages the zone. The email address is used to generate the SOA record set of 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
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	Primary DNS servers, from which the secondary DNS servers get DNS information. Currently, this parameter is not used.

**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
message	String	Description

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Error code
message	String	Description

Example Requests

Disabling a public zone

PUT https://{endpoint}/v2/zones/{zone_id}/statuses

{
  "status" : "DISABLE"
}

Example Responses

Status code: 202

Response to the request for updating the status of a public zone.

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