文档首页/ 云防火墙 CFW/ API参考/ API/ 黑白名单管理/ 批量添加黑白名单列表
更新时间：2025-08-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量添加黑白名单列表

功能介绍

批量添加黑白名单列表

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/black-white-lists

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。项目ID获取方式

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

list_items

是

Array of BlackWhiteInfo objects

参数解释：

黑白名单信息列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

list_type

是

Integer

参数解释：

黑白名单列表类型

约束限制：

不涉及

取值范围：

4：黑名单

5：白名单

默认取值：

不涉及

object_id

是

String

参数解释：

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，type为0时，object_id为互联网边界防护对象ID，type为1时，object_id为VPC边界防护对象ID，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 BlackWhiteInfo

参数

是否必选

参数类型

描述

address

是

String

参数解释：

IP地址

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

address_type

否

Integer

参数解释：

IP地址类型

约束限制：

不涉及

取值范围：

0：IPV4

1：IPV6

默认取值：

不涉及

description

否

String

参数解释：

描述

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

direction

是

Integer

参数解释：

地址方向

约束限制：

不涉及

取值范围：

0：源地址

1：目的地址

默认取值：

不涉及

port

否

String

参数解释：

端口

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

protocol

是

Integer

参数解释：

协议类型

约束限制：

不涉及

取值范围：

-1：ANY

1：ICMP

6：TCP

17：UDP

58：ICMPV6

132：SCTP

手动类型不为空，自动类型为空

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

AddBlackWhiteListBatchVO object
表5 AddBlackWhiteListBatchVO

参数

参数类型

描述

duplicated_list

Array of BlackWhiteInfo objects

参数解释：

黑白名单重复添加列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

failed_list

Array of BlackWhiteInfo objects

参数解释：

黑白名单添加失败列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

success_list

Array of BlackWhiteInfo objects

参数解释：

黑白名单添加成功列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表6 BlackWhiteInfo

参数

参数类型

描述

address

String

参数解释：

IP地址

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

address_type

Integer

参数解释：

IP地址类型

约束限制：

不涉及

取值范围：

0：IPV4

1：IPV6

默认取值：

不涉及

description

String

参数解释：

描述

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

direction

Integer

参数解释：

地址方向

约束限制：

不涉及

取值范围：

0：源地址

1：目的地址

默认取值：

不涉及

port

String

参数解释：

端口

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

protocol

Integer

参数解释：

协议类型

约束限制：

不涉及

取值范围：

-1：ANY

1：ICMP

6：TCP

17：UDP

58：ICMPV6

132：SCTP

手动类型不为空，自动类型为空

默认取值：

不涉及

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码

取值范围：

不涉及

error_msg

String

参数解释：

错误描述

取值范围：

不涉及

请求示例

批量添加黑名单列表，项目id为5de88e3e18124fa99675fb51ceceaa31，将ip地址1.2.3.4、2.3.4.5、3.4.5.6添加进黑名单

https://{Endpoint}/v1/5de88e3e18124fa99675fb51ceceaa31/black-white-lists

{
  "object_id" : "c5bee3c1-63aa-405f-8a38-8bac2b5674e1",
  "list_type" : 4,
  "list_items" : [ {
    "address" : "1.2.3.4",
    "direction" : 0,
    "protocol" : -1
  }, {
    "address" : "2.3.4.5",
    "direction" : 0,
    "protocol" : -1
  }, {
    "address" : "3.4.5.6",
    "direction" : 0,
    "protocol" : -1
  } ]
}

响应示例

状态码：200

OK

{
  "data" : {
    "duplicated_list" : [ ],
    "failed_list" : [ ],
    "success_list" : [ {
      "address" : "1.2.3.4",
      "address_type" : 0,
      "direction" : 0,
      "port" : "1-65535",
      "protocol" : -1
    }, {
      "address" : "2.3.4.5",
      "address_type" : 0,
      "direction" : 0,
      "port" : "1-65535",
      "protocol" : -1
    }, {
      "address" : "3.4.5.6",
      "address_type" : 0,
      "direction" : 0,
      "port" : "1-65535",
      "protocol" : -1
    } ]
  }
}

状态码：400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 黑白名单管理

相关文档