更新时间:2024-10-31 GMT+08:00

删除黑白名单规则

功能介绍

删除黑白名单规则

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

list_id

String

黑白名单列表id,可通过查询黑白名单列表接口查询获得,通过返回值中的data.records.list_id(.表示各对象之间层级的区分)获得。

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

fw_instance_id

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。可通过如何获取用户Token获取。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

BlackWhiteListId object

删除黑白名单响应数据

表5 BlackWhiteListId

参数

参数类型

描述

id

String

黑白名单id

name

String

黑白名单名称,为黑白名单的地址

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

删除项目id为9d80d070b6d44942af73c9c3d38e0429下的黑白名单id为2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a的黑白名单

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a

响应示例

状态码: 200

删除黑白名单响应

{
  "data" : {
    "id" : "2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a"
  }
}

状态码: 400

Bad Request

{
  "error_code" : "CFW.00200005",
  "error_msg" : "操作内容不存在"
}

状态码

状态码

描述

200

删除黑白名单响应

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码