文档首页/ 云防火墙 CFW/ API参考/ API/ 流量过滤/ 导入IP黑名单用于流量过滤
更新时间:2025-08-12 GMT+08:00

导入IP黑名单用于流量过滤

功能介绍

此接口用来导入IP黑名单,IP列表保存在request的body中,IP列表支持的格式如下:

单个IP地址,例如:100.1.1.10

连续的IP地址段,例如:80.1.1.3-80.1.1.30

掩码格式的网段,例如:6.6.6.0/24

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/ptf/ip-blacklist/import

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,可以通过调用API获取,也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

防火墙ID,可通过防火墙ID获取方式获取

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

add_type

Integer

IP黑名单导入的方式,0表示增量导入,在原来的基础上追加;1表示全量导入,新导入的IP黑名单会覆盖已有的IP黑名单

ip_blacklist

String

IP列表,当前支持不同的IP地址之间使用“,” 、“ ”、“;”、“\r\n”、“\n”、“\t”等分隔符进行分隔。

effect_scope

Array of integers

生效范围,1表示生效范围为eip, 2表示生效范围为nat, [1 2]表示 生效范围为eip和nat

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

Object

导入数据

请求示例

全量方式导入一个IP黑名单,项目id为eefb11b22d5944f2aa067954516df1cf,防护对象 id为812f478c-940e-4e00-824f-7287250d76dc,

生效范围为EIP,IP列表为“100.1.1.10\n80.1.1.3-80.1.1.30\n6.6.6.0/24\n2001:db8::2-2001:db8::200\n3001:db8::2\n4001:db8::2/64”, v4格式和v6格式的ip可以一起导入,ip之间使用\n分隔。

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

ImportIpBlacklistRequestBody:
{
  "add_type": 1,
  "ip_blacklist": "100.1.1.10\n80.1.1.3-80.1.1.30\n6.6.6.0/24\n2001:db8::2-2001:db8::200\n3001:db8::2\n4001:db8::2/64",
  "effect_scope": [
    1 ]
}

响应示例

SDK代码示例

SDK代码示例如下。

全量方式导入一个IP黑名单,项目id为eefb11b22d5944f2aa067954516df1cf,防护对象 id为812f478c-940e-4e00-824f-7287250d76dc,

生效范围为EIP,IP列表为“100.1.1.10\n80.1.1.3-80.1.1.30\n6.6.6.0/24\n2001:db8::2-2001:db8::200\n3001:db8::2\n4001:db8::2/64”, v4格式和v6格式的ip可以一起导入,ip之间使用\n分隔。

 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
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.*;


public class ImportIpBlacklistSolution {

    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();
        ImportIpBlacklistRequest request = new ImportIpBlacklistRequest();
        try {
            ImportIpBlacklistResponse response = client.importIpBlacklist(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());
        }
    }
}

全量方式导入一个IP黑名单,项目id为eefb11b22d5944f2aa067954516df1cf,防护对象 id为812f478c-940e-4e00-824f-7287250d76dc,

生效范围为EIP,IP列表为“100.1.1.10\n80.1.1.3-80.1.1.30\n6.6.6.0/24\n2001:db8::2-2001:db8::200\n3001:db8::2\n4001:db8::2/64”, v4格式和v6格式的ip可以一起导入,ip之间使用\n分隔。

 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
# 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 = ImportIpBlacklistRequest()
        response = client.import_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)

全量方式导入一个IP黑名单,项目id为eefb11b22d5944f2aa067954516df1cf,防护对象 id为812f478c-940e-4e00-824f-7287250d76dc,

生效范围为EIP,IP列表为“100.1.1.10\n80.1.1.3-80.1.1.30\n6.6.6.0/24\n2001:db8::2-2001:db8::200\n3001:db8::2\n4001:db8::2/64”, v4格式和v6格式的ip可以一起导入,ip之间使用\n分隔。

 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
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.ImportIpBlacklistRequest{}
	response, err := client.ImportIpBlacklist(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

导入成功的响应,此响应体在成功的情况下字段都不赋值

401

鉴权认证失败

403

不允许操作

500

内部错误

错误码

请参见错误码