Updated on 2024-12-20 GMT+08:00

Batch Deleting Record Sets

Function

This API is used to batch delete record sets.

The response contains only the record sets that are deleted.

You can delete record sets in public and private zones in batches.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2.1/recordsets

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

zone_type

Yes

String

Zone type. The value can be public or private.

recordset_ids

Yes

Array of strings

ID list of record sets to be deleted. You can specify a maximum of 100 IDs.

Response Parameters

Status code: 202

Table 2 Response body parameters

Parameter

Type

Description

recordsets

Array of recordsetData objects

Response to the request for deleting record sets in batches

metadata

metadata object

Number of resources that meet the query condition.

Table 3 recordsetData

Parameter

Type

Description

id

String

Record set ID

name

String

Record set name

description

String

Record set description

zone_id

String

Zone ID of the record set

zone_name

String

Zone name of the record set

type

String

Record set type

ttl

Integer

Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect.

records

Array of strings

Record set value

created_at

String

Time when the record set was created

updated_at

String

Time when the record set was updated

status

String

Resource status

default

Boolean

Whether the record set is generated by the system. A system-generated record set cannot be deleted.

project_id

String

Project ID of the record set

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.

line

String

Resolution line ID

weight

Integer

Weight of the record set

health_check_id

String

Health check ID

alias_target

alias_target object

Domain name alias

Table 5 alias_target

Parameter

Type

Description

resource_type

String

Service that supports domain name aliases.

Value options:

  • cloudsite: CloudSite

  • waf: Web Application Firewall

resource_domain_name

String

Domain name of the target service

Table 6 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 7 Response body parameters

Parameter

Type

Description

code

String

Error code

message

String

Description

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

code

String

Error code

message

String

Description

Example Requests

Deleting record sets added to a public zone in batches

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

{
  "zone_type" : "public",
  "recordset_ids" : [ "2c9eb155587194ec01587224c9f9014a", "2c9eb155587194ec01587224c9f9014c" ]
}

Example Responses

Status code: 202

Response to the request for batch deleting record sets

{
  "links" : {
    "self" : "https://Endpoint/v2.1/recordsets"
  },
  "recordsets" : [ {
    "id" : "2c9eb155587194ec01587224c9f9014a",
    "name" : "example.com.",
    "type" : "A",
    "ttl" : 300,
    "records" : [ "1.1.1.1" ],
    "status" : "PENDING_DELETE",
    "links" : {
      "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "created_at" : "2016-11-17T11:56:03.439",
    "updated_at" : "2016-11-17T11:56:06.439",
    "default" : false,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "line" : "default_view",
    "weight" : null,
    "set_id" : null
  }, {
    "id" : "2c9eb155587194ec01587224c9f9014c",
    "name" : "1.example.com.",
    "type" : "A",
    "ttl" : 172800,
    "records" : [ "2.2.2.2" ],
    "status" : "PENDING_DELETE",
    "links" : {
      "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "created_at" : "2016-11-17T11:56:03.439",
    "updated_at" : "2016-11-17T11:56:06.439",
    "default" : false,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "line" : "default_view",
    "weight" : null,
    "set_id" : null
  } ],
  "metadata" : {
    "total_count" : 2
  }
}

Status Codes

Status Code

Description

202

Response to the request for batch deleting record sets

400

Error response

500

Error response

Error Codes

See Error Codes.