Batch Setting Zone Status

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

Online Debugging

CLI Examples

View PDF

Function

This API is used to set the status of zones in batches. The response contains only the zones that are updated. Both public and private zones are supported.

Calling Method

For details, see Calling APIs.

URI

PUT /v2.1/zones/statuses

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
status	Yes	String	Zone status. The value can only be DISABLE or ENABLE.
zone_ids	Yes	Array of strings	ID list of zones to be set. You can specify a maximum of 50 IDs.

Response Parameters

Status code: 202

**Table 2** Response body parameters
Parameter	Type	Description
links	Link object	Link to the current resource.
zones	Array of ZoneData objects	Response to the request for setting the status of zones in batches
metadata	metadata object	Number of resources that meet the query condition.

**Table 3** ZoneData
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 for the zone.
ttl	String	TTL value of the SOA record set in the zone
serial	String	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.
masters	String	Primary DNS servers, from which the secondary DNS servers get DNS information.
status	String	Resource status
pool_id	String	Pool that hosts the zone. The pool which is assigned by the system.
project_id	String	Project ID of the zone
zone_type	String	Zone type. The value can be public or private.
created_at	String	Time when the zone was created. UTC time format: YYYY-MM-DDTHH:MM:SSZ
updated_at	String	Time when the zone was updated UTC time format: YYYY-MM-DDTHH:MM:SSZ
record_num	String	Number of record sets in the zone
links	Link object	Link to the current resource.

**Table 4** Link
Parameter	Type	Description
self	String	Link to the current resource.

**Table 5** metadata
Parameter	Type	Description
total_count	Integer	Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

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 zones in batches

PUT https://{endpoint}/v2.1/zones/statuses

{
  "status" : "DISABLE",
  "zone_ids" : [ "2c9eb155587194ec01587224c9f90149", "2c9eb155587194ec01587224c9f90150" ]
}

Example Responses

Status code: 202

Response to the request for batch setting zone status

{
  "links" : {
    "self" : "https://Endpoint/v2.1/zones/statuses"
  },
  "zones" : [ {
    "id" : "2c9eb155587194ec01587224c9f90149",
    "name" : "example.com.",
    "description" : "This is an example zone.",
    "email" : "xx@example.com",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "status" : "DISABLE",
    "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,
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
    }
  }, {
    "id" : "2c9eb155587228570158722996c50001",
    "name" : "example.org.",
    "description" : "This is an example zone.",
    "email" : "xx@example.org",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "status" : "DISABLE",
    "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,
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001"
    }
  } ],
  "metadata" : {
    "total_count" : 2
  }
}