Help Center/ Domain Name Service/ API Reference/ APIs/ Record Set Management (v2.1)/ Deleting Record Sets in a Zone in Batches
Updated on 2026-09-28 GMT+08:00

Deleting Record Sets in a Zone in Batches

Function

This API is used to batch delete record sets in a zone.

The response contains only the record sets that are deleted.

Both public and private zones are supported.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dns:recordset:delete

    Write

    zone *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    • dns:recordset:disassociatehealthcheck
    • ces:siteMonitorRule:showHealthCheck
    • ces:siteMonitorRule:put
    • ces:siteMonitorRule:delete
    • ces:siteMonitorRule:list

    -

    • dns:RecordSetNames

    • dns:RecordSetTypes

URI

DELETE /v2.1/zones/{zone_id}/recordsets

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

zone_id

Yes

String

Definition

Zone ID. You can obtain the ID by calling the API for querying public zones (ListPublicZones) or for querying private zones (ListPrivateZones).

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which is used for identity authentication. It must be carried in the request header to verify the user identity during API calls.

You can obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

For details about how to obtain a user token, see Obtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

recordset_ids

Yes

Array of strings

Definition

IDs of record sets. This field is a string array. Each element is a record set ID. You can obtain the IDs by calling the API (ShowRecordSetByZone) for querying the record sets of a zone.

Constraints

You can specify a maximum of 100 IDs.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

links

pageLink object

Definition

Links to the current page and the next page. If pagination is required for querying resources, a next field is required to point to the next page.

recordsets

Array of QueryRecordSetWithLineResp objects

Definition

Record set list. This field is an array. Each element contains fields such as the record set ID, name, type, TTL, and record value list.

metadata

metadata object

Definition

Metadata information about the pagination query, including the total number of resources (total_count) that meet the query conditions.

Table 5 QueryRecordSetWithLineResp

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.

zone_id

String

Definition

Zone ID of the record set

Range

N/A

zone_name

String

Definition

Zone name of the record set

Range

N/A

type

String

Definition

Record set type.

Range

  • A: maps a domain name to specified IPv4 addresses.

  • AAAA: maps a domain name to specified IPv6 addresses.

  • MX: maps domain names to email servers.

  • CNAME: maps one domain name to another domain name or multiple domain names to one domain name.

  • TXT: stores text-based information associated with a domain name.

  • SRV: records the services provided by servers.

  • NS: specifies the authoritative DNS server of a domain name.

  • SOA: provides basic information about domain names and details about authoritative servers.

  • CAA: specifies the CA that issues HTTPS certificates for a domain name to prevent incorrect certificate issuing. It only applies to public domain name resolution.

  • PTR: maps an IP address back to a domain name. It only applies to private domain name resolution.

ttl

Integer

Definition

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

Range

1 to 2147483647

records

Array of strings

Definition

Record set value. This field is a string array. Each element is the value of a record set.

created_at

String

Definition

The time when the record set was created.

The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000.

Range

N/A

updated_at

String

Definition

The time when the record set was last modified.

The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000.

Range

N/A

status

String

Definition

The status of the record set.

Range

  • ACTIVE: The zone is normal.

  • PENDING_CREATE: The zone is being created.

  • PENDING_UPDATE: The zone is being updated.

  • PENDING_DELETE: The zone is being deleted.

  • PENDING_FREEZE: The zone is being frozen.

  • FREEZE: The zone is frozen.

  • ILLEGAL: The zone is frozen due to abuse.

  • POLICE: The zone is frozen due to security reasons.

  • PENDING_DISABLE: The zone is being disabled.

  • DISABLE: The zone is disabled.

  • ERROR: The zone failed to be created.

default

Boolean

Definition

Whether the record set is created by default. A default record set cannot be deleted.

Range

  • true: The record set is generated by the system by default and cannot be deleted.

  • false: The record set is not generated by the system by default and can be deleted.

project_id

String

Definition

ID of the project to which the record set belongs

Range

N/A

links

pageLink object

Definition

Links to the current page and the next page. If pagination is required for querying resources, a next field is required to point to the next page.

line

String

Definition

Resolution line ID

Range

N/A

weight

Integer

Definition

Weight of the record set

Range

0 to 1000

health_check_id

String

Definition

Health check ID

Range

N/A

alias_target

alias_target object

Definition

Domain name alias.

bundle

String

Definition

Specification, which is the default specification. This field is reserved.

Range

N/A

Table 7 alias_target

Parameter

Type

Description

resource_type

String

Definition

Service that supports domain name aliases.

Range

  • cloudsite: Enterprise Web Portal (EWP)

  • waf: Web Application Firewall (WAF)

resource_domain_name

String

Definition

Domain name of the target service.

Range

N/A

Table 8 metadata

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

Example Requests

Deleting record sets in a zone in batches

DELETE https://{Endpoint}/v2.1/zones/{zone_id}/recordsets

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

Example Responses

Status code: 202

{
  "links" : {
    "self" : "https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/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
  }, {
    "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
  } ],
  "metadata" : {
    "total_count" : 2
  }
}

SDK Sample Code

The SDK sample code is as follows.

Deleting record sets in a zone in batches

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dns.v2.region.DnsRegion;
import com.huaweicloud.sdk.dns.v2.*;
import com.huaweicloud.sdk.dns.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchDeleteRecordSetWithLineSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DnsClient client = DnsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DnsRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchDeleteRecordSetWithLineRequest request = new BatchDeleteRecordSetWithLineRequest();
        request.withZoneId("{zone_id}");
        BatchDeleteRecordSetWithLineRequestBody body = new BatchDeleteRecordSetWithLineRequestBody();
        List<String> listbodyRecordsetIds = new ArrayList<>();
        listbodyRecordsetIds.add("2c9eb155587194ec01587224c9f9014a");
        listbodyRecordsetIds.add("2c9eb155587194ec01587224c9f9014c");
        body.withRecordsetIds(listbodyRecordsetIds);
        request.withBody(body);
        try {
            BatchDeleteRecordSetWithLineResponse response = client.batchDeleteRecordSetWithLine(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Deleting record sets in a zone in batches

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdns.v2.region.dns_region import DnsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdns.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = DnsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DnsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchDeleteRecordSetWithLineRequest()
        request.zone_id = "{zone_id}"
        listRecordsetIdsbody = [
            "2c9eb155587194ec01587224c9f9014a",
            "2c9eb155587194ec01587224c9f9014c"
        ]
        request.body = BatchDeleteRecordSetWithLineRequestBody(
            recordset_ids=listRecordsetIdsbody
        )
        response = client.batch_delete_record_set_with_line(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Deleting record sets in a zone in batches

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dns.DnsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dns.NewDnsClient(hcClient)

    request := &model.BatchDeleteRecordSetWithLineRequest{}
	request.ZoneId = "{zone_id}"
	var listRecordsetIdsbody = []string{
        "2c9eb155587194ec01587224c9f9014a",
	    "2c9eb155587194ec01587224c9f9014c",
    }
	request.Body = &model.BatchDeleteRecordSetWithLineRequestBody{
		RecordsetIds: listRecordsetIdsbody,
	}
	response, err := client.BatchDeleteRecordSetWithLine(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

202

Request accepted

Error Codes

See Error Codes.