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

Deleting Domain Groups in Batches

Function

This API is used to delete domain name groups in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/domain-sets/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by calling an API or from the console. You can obtain it by referring to Obtaining a Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

fw_instance_id

No

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

enterprise_project_id

No

String

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by referring to Obtaining a User Token.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

object_id

No

String

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, object_id is the protected object ID on the Internet border. If the value of type is 1, object_id is the protected object ID on the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

set_ids

No

Array of strings

Domain name group ID list. A domain name ID can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

HttpBatchDeleteDomainSetResponseDatas object

Table 6 HttpBatchDeleteDomainSetResponseDatas

Parameter

Type

Description

responseDatas

Array of DomainSetId objects

Return value for deleting domain name groups in batches.

Table 7 DomainSetId

Parameter

Type

Description

name

String

Domain group name.

id

String

Domain name group ID.

Example Requests

Delete domain groups in batches. The firewall ID is fced7179-64a4-4438-bc6d-b510a2da2f64, the target protected object ID is b71922fd-3539-421c-9317-c54ebc1bc4ea, the IDs of the domain groups to be deleted are 7d772766-6c44-4fa3-a140-8ddc7eac0fc5 and e17e24d2-bd7d-4e25-993c-38559d44a571, and the project ID is 408972e72dcd4c1a9b033e955802a36b.

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/domain-sets/batch-delete

{
  "object_id" : "b71922fd-3539-421c-9317-c54ebc1bc4ea",
  "set_ids" : [ "7d772766-6c44-4fa3-a140-8ddc7eac0fc5", "e17e24d2-bd7d-4e25-993c-38559d44a571" ]
}

Example Responses

Status code: 200

Response to the request for deleting domain groups in batches.

{
  "data" : {
    "responseDatas" : [ {
      "name" : "9",
      "id" : "7d772766-6c44-4fa3-a140-8ddc7eac0fc5"
    }, {
      "name" : "8",
      "id" : "e17e24d2-bd7d-4e25-993c-38559d44a571"
    } ]
  }
}

SDK Sample Code

The SDK sample code is as follows.

Delete domain groups in batches. The firewall ID is fced7179-64a4-4438-bc6d-b510a2da2f64, the target protected object ID is b71922fd-3539-421c-9317-c54ebc1bc4ea, the IDs of the domain groups to be deleted are 7d772766-6c44-4fa3-a140-8ddc7eac0fc5 and e17e24d2-bd7d-4e25-993c-38559d44a571, and the project ID is 408972e72dcd4c1a9b033e955802a36b.

 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
56
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.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;

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

public class BatchDeleteDomainSetSolution {

    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");
        String projectId = "{project_id}";

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

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchDeleteDomainSetRequest request = new BatchDeleteDomainSetRequest();
        BatchDeleteDomainSetsDto body = new BatchDeleteDomainSetsDto();
        List<String> listbodySetIds = new ArrayList<>();
        listbodySetIds.add("7d772766-6c44-4fa3-a140-8ddc7eac0fc5");
        listbodySetIds.add("e17e24d2-bd7d-4e25-993c-38559d44a571");
        body.withSetIds(listbodySetIds);
        body.withObjectId("b71922fd-3539-421c-9317-c54ebc1bc4ea");
        request.withBody(body);
        try {
            BatchDeleteDomainSetResponse response = client.batchDeleteDomainSet(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());
        }
    }
}

Delete domain groups in batches. The firewall ID is fced7179-64a4-4438-bc6d-b510a2da2f64, the target protected object ID is b71922fd-3539-421c-9317-c54ebc1bc4ea, the IDs of the domain groups to be deleted are 7d772766-6c44-4fa3-a140-8ddc7eac0fc5 and e17e24d2-bd7d-4e25-993c-38559d44a571, and the project ID is 408972e72dcd4c1a9b033e955802a36b.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.v1 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = BatchDeleteDomainSetRequest()
        listSetIdsbody = [
            "7d772766-6c44-4fa3-a140-8ddc7eac0fc5",
            "e17e24d2-bd7d-4e25-993c-38559d44a571"
        ]
        request.body = BatchDeleteDomainSetsDto(
            set_ids=listSetIdsbody,
            object_id="b71922fd-3539-421c-9317-c54ebc1bc4ea"
        )
        response = client.batch_delete_domain_set(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Delete domain groups in batches. The firewall ID is fced7179-64a4-4438-bc6d-b510a2da2f64, the target protected object ID is b71922fd-3539-421c-9317-c54ebc1bc4ea, the IDs of the domain groups to be deleted are 7d772766-6c44-4fa3-a140-8ddc7eac0fc5 and e17e24d2-bd7d-4e25-993c-38559d44a571, and the project ID is 408972e72dcd4c1a9b033e955802a36b.

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchDeleteDomainSetRequest{}
	var listSetIdsbody = []string{
        "7d772766-6c44-4fa3-a140-8ddc7eac0fc5",
	    "e17e24d2-bd7d-4e25-993c-38559d44a571",
    }
	objectIdBatchDeleteDomainSetsDto:= "b71922fd-3539-421c-9317-c54ebc1bc4ea"
	request.Body = &model.BatchDeleteDomainSetsDto{
		SetIds: &listSetIdsbody,
		ObjectId: &objectIdBatchDeleteDomainSetsDto,
	}
	response, err := client.BatchDeleteDomainSet(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

200

Response to the request for deleting domain groups in batches.

401

Unauthorized: Request error.

403

Forbidden: Access forbidden.

404

Not Found: Web page not found.

Error Codes

See Error Codes.