Batch Deleting Zones

Function

This API is used to batch delete zones. This is an atomic operation. All zones are deleted or fail to be deleted. Both public and private zones are supported.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2.1/zones

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
zone_type	Yes	String	Zone type. The value can be public or private.
zone_ids	Yes	Array of strings	ID list of zones to be deleted. You can specify a maximum of 50 IDs.

Response Parameters

Status code: 202

**Table 2** Response body parameters
Parameter	Type	Description
zones	Array of zoneData objects	Response to the request for deleting 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.
zone_type	String	Zone type. The value can be public or private.
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.
status	String	Resource status
record_num	String	Number of record sets in the zone
pool_id	String	Pool that hosts the zone. The pool which is assigned by the system.
project_id	String	Project ID of the zone
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
links	pageLink object	Link of the current resource or other related resources. When a response is broken into pages, we will include a next link to retrieve all results.
masters	String	Primary DNS servers, from which the secondary DNS servers get DNS information.

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

**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

Deleting zones in batches

DELETE https://{endpoint}/v2.1/zones

{
  "zone_type" : "public",
  "zone_ids" : [ "2c9eb155587194ec01587224c9f90149", "2c9eb155587194ec01587224c9f90150" ]
}

Example Responses

Status code: 202

Response to the request for batch deleting zones

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