Batch Deleting Record Sets
Function
This API is used to delete record sets in batches.
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
zone_type |
Yes |
String |
Definition Zone type Constraints N/A Range
Default Value N/A |
recordset_ids |
Yes |
Array of strings |
Definition ID list of record sets to be deleted Constraints You can specify a maximum of 100 IDs. Range N/A Default Value N/A |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
recordsets |
Array of RecordsetData objects |
Definition Record set list Range N/A |
metadata |
metadata object |
Definition The number of resources that meet filter conditions. Range N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Record set ID Range N/A |
name |
String |
Definition Record set name Range N/A |
description |
String |
Definition The description of the record set. Range The value can contain a maximum of 255 characters. |
type |
String |
Definition Record set type Range
|
ttl |
Integer |
Definition Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect. Range 1 to 2147483647 |
records |
Array of strings |
Definition Record set value Range N/A |
status |
String |
Definition The status of the record set. Range
|
zone_id |
String |
Definition Zone ID of the record set Range N/A |
zone_name |
String |
Definition The zone that hosts the record set. Range N/A |
line |
String |
Definition Resolution line ID Range N/A |
alias_target |
alias_target object |
Definition Domain name alias Range N/A |
created_at |
String |
Definition The creation time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A |
updated_at |
String |
Definition The update time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A |
health_check_id |
String |
Definition Health check ID Range N/A |
default |
Boolean |
Definition Whether the record set is created by default. A default record set cannot be deleted. Range N/A |
project_id |
String |
Definition ID of the project to which the record set belongs Range N/A |
links |
Link object |
Link to the current resource. |
weight |
Integer |
Definition Weight of the record set Range 0 to 1000 |
Parameter |
Type |
Description |
---|---|---|
resource_type |
String |
Definition Services that support domain name aliases Constraints N/A Range
Default Value N/A |
resource_domain_name |
String |
Definition Domain name of the target service Constraints N/A Range N/A Default Value N/A |
Parameter |
Type |
Description |
---|---|---|
total_count |
Integer |
Definition Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. Range N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition Error code Range N/A |
message |
String |
Definition Error description Range N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition Error code Range N/A |
message |
String |
Definition Error description Range N/A |
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
Request accepted
{ "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 |
Request accepted |
400 |
Error response |
500 |
Error response |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.