Help Center/ Cloud Firewall/ API Reference/ API/ Filtering traffic/ Deleting the Imported IP Address Blacklist
Updated on 2025-08-12 GMT+08:00

Deleting the Imported IP Address Blacklist

Function

Delete the imported IP address blacklist of the traffic filtering function with a specified effective scope. For the standard edition, only the IP address blacklist whose effective scope is EIP is available. For the professional edition, the IP address blacklist whose effective scope is EIP and NAT is available.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/ptf/ip-blacklist

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

fw_instance_id

Yes

String

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

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

effect_scope

No

Array of integers

Effective scope: 1 (the effective scope for deletion is EIP), 2 (the effective scope for deletion is NAT), 1,2 (the effective scope for deletion is EIP and NAT)

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

Object

Data import

Example Requests

Delete the IP address blacklist with the project ID eefb11b22d5944f2aa067954516df1cf and firewall instance ID 812f478c-940e-4e00-824f-7287250d76dc, and specify the effective scope as EIP.

https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/ptf/ip-blacklist?fw_instance_id=812f478c-940e-4e00-824f-7287250d76dc

{
  "effect_scope" : [ 1 ]
}

Example Responses

Status code: 200

Response returned after an IP address blacklist is successfully deleted. If the deletion succeeds, all characters in the response body are empty.

{ }

SDK Sample Code

The SDK sample code is as follows.

Delete the IP address blacklist with the project ID eefb11b22d5944f2aa067954516df1cf and firewall instance ID 812f478c-940e-4e00-824f-7287250d76dc, and specify the effective scope as EIP.

 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.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 DeleteIpBlacklistSolution {

    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();
        DeleteIpBlacklistRequest request = new DeleteIpBlacklistRequest();
        IpBlacklistDeleteDto body = new IpBlacklistDeleteDto();
        List<Integer> listbodyEffectScope = new ArrayList<>();
        listbodyEffectScope.add(1);
        body.withEffectScope(listbodyEffectScope);
        request.withBody(body);
        try {
            DeleteIpBlacklistResponse response = client.deleteIpBlacklist(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 the IP address blacklist with the project ID eefb11b22d5944f2aa067954516df1cf and firewall instance ID 812f478c-940e-4e00-824f-7287250d76dc, and specify the effective scope as EIP.

 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
# 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 = DeleteIpBlacklistRequest()
        listEffectScopebody = [
            1
        ]
        request.body = IpBlacklistDeleteDto(
            effect_scope=listEffectScopebody
        )
        response = client.delete_ip_blacklist(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 the IP address blacklist with the project ID eefb11b22d5944f2aa067954516df1cf and firewall instance ID 812f478c-940e-4e00-824f-7287250d76dc, and specify the effective scope as EIP.

 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
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.DeleteIpBlacklistRequest{}
	var listEffectScopebody = []int32{
        int32(1),
    }
	request.Body = &model.IpBlacklistDeleteDto{
		EffectScope: &listEffectScopebody,
	}
	response, err := client.DeleteIpBlacklist(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 returned after an IP address blacklist is successfully deleted. If the deletion succeeds, all characters in the response body are empty.

401

Unauthorized: Request error.

403

Forbidden: Access forbidden.

Error Codes

See Error Codes.