文档首页/ 云防火墙 CFW/ API参考/ API/ 黑白名单管理/ 批量删除黑白名单列表
更新时间:2025-08-28 GMT+08:00
分享

批量删除黑白名单列表

功能介绍

批量删除黑白名单列表

调用方法

请参见如何调用API

URI

DELETE /v1/{project_id}/black-white-list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

list_ids

Array of strings

参数解释

黑白名单列表ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

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(.表示各对象之间层级的区分)获得

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

Array of strings

参数解释

批量删除黑白名单列表id

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

批量删除黑名单,项目id为5de88e3e18124fa99675fb51ceceaa31,删除list_id为1662d45b-8a39-4119-b905-c429ad038cf0、6bb15c8e-dbe1-4314-bbde-90c806cb0663、4d574d5d-3867-4a7f-9645-95ccfdf3f3a0的黑名单

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

{
  "list_ids" : [ "1662d45b-8a39-4119-b905-c429ad038cf0", "6bb15c8e-dbe1-4314-bbde-90c806cb0663", "4d574d5d-3867-4a7f-9645-95ccfdf3f3a0" ],
  "list_type" : 4,
  "object_id" : "c5bee3c1-63aa-405f-8a38-8bac2b5674e1"
}

响应示例

状态码:200

OK

{
  "data" : [ "1662d45b-8a39-4119-b905-c429ad038cf0" ]
}

状态码:400

Bad Request

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档