Help Center/ Cloud Firewall/ API Reference/ API/ ACL Rule Management/ Deleting ACL Rules in Batches
Updated on 2024-10-31 GMT+08:00

Deleting ACL Rules in Batches

Function

This API is used to delete ACL rules in batches.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/acl-rule

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. For details, see Obtaining a Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

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.

fw_instance_id

No

String

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

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain the token by referring to Obtaining a User Token.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

object_id

Yes

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, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to 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).

rule_ids

Yes

Array of strings

Rule ID list, which is the ID list transferred when rules are deleted in batches. Rule IDs can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_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

BatchDeleteAclRulesResponseData object

Returned data for deleting ACL rules in batches.

Table 6 BatchDeleteAclRulesResponseData

Parameter

Type

Description

responseDatas

Array of BatchDeleteRuleInfo objects

Data returned when rules are deleted in batches.

Table 7 BatchDeleteRuleInfo

Parameter

Type

Description

name

String

Names of the ACL rules to be deleted in batches.

id

String

IDs of the ACL rules to be deleted in batches.

Example Requests

Delete rules 0475c516-0e41-4caf-990b-0c504eebd73f and 8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 from the protected object ae42418e-f077-41a0-9d3b-5b2f5ad9102b whose project ID is 9d80d070b6d44942af73c9c3d38e0429.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule

{
  "rule_ids" : [ "0475c516-0e41-4caf-990b-0c504eebd73f", "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6" ],
  "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
}

Example Responses

Status code: 200

Return value for deleting rules in batches.

{
  "data" : {
    "responseDatas" : [ {
      "name" : "test",
      "id" : "0475c516-0e41-4caf-990b-0c504eebd73f"
    }, {
      "name" : "test2",
      "id" : "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6"
    } ]
  }
}

SDK Sample Code

The SDK sample code is as follows.

Java

Delete rules 0475c516-0e41-4caf-990b-0c504eebd73f and 8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 from the protected object ae42418e-f077-41a0-9d3b-5b2f5ad9102b whose project ID is 9d80d070b6d44942af73c9c3d38e0429.

 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 BatchDeleteAclRulesSolution {

    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();
        BatchDeleteAclRulesRequest request = new BatchDeleteAclRulesRequest();
        DeleteRuleAclDto body = new DeleteRuleAclDto();
        List<String> listbodyRuleIds = new ArrayList<>();
        listbodyRuleIds.add("0475c516-0e41-4caf-990b-0c504eebd73f");
        listbodyRuleIds.add("8662868e-fe7e-4dfc-bfb1-ca4d73081ca6");
        body.withRuleIds(listbodyRuleIds);
        body.withObjectId("ae42418e-f077-41a0-9d3b-5b2f5ad9102b");
        request.withBody(body);
        try {
            BatchDeleteAclRulesResponse response = client.batchDeleteAclRules(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());
        }
    }
}

Python

Delete rules 0475c516-0e41-4caf-990b-0c504eebd73f and 8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 from the protected object ae42418e-f077-41a0-9d3b-5b2f5ad9102b whose project ID is 9d80d070b6d44942af73c9c3d38e0429.

 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 = BatchDeleteAclRulesRequest()
        listRuleIdsbody = [
            "0475c516-0e41-4caf-990b-0c504eebd73f",
            "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6"
        ]
        request.body = DeleteRuleAclDto(
            rule_ids=listRuleIdsbody,
            object_id="ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
        )
        response = client.batch_delete_acl_rules(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Delete rules 0475c516-0e41-4caf-990b-0c504eebd73f and 8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 from the protected object ae42418e-f077-41a0-9d3b-5b2f5ad9102b whose project ID is 9d80d070b6d44942af73c9c3d38e0429.

 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
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.BatchDeleteAclRulesRequest{}
	var listRuleIdsbody = []string{
        "0475c516-0e41-4caf-990b-0c504eebd73f",
	    "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6",
    }
	request.Body = &model.DeleteRuleAclDto{
		RuleIds: listRuleIdsbody,
		ObjectId: "ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
	}
	response, err := client.BatchDeleteAclRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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

Return value for deleting rules in batches.

Error Codes

See Error Codes.