文档首页/ 云防火墙 CFW/ API参考（安卡拉区域）/ API/ 黑白名单管理/ 更新黑白名单列表
更新时间：2024-12-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新黑白名单列表

功能介绍

更新黑白名单列表

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目id

list_id

是

String

黑白名单列表id
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目id，用户支持企业项目后，由企业项目生成的id。

fw_instance_id

否

String

防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）
表4 请求Body参数

参数

是否必选

参数类型

描述

direction

否

Integer

地址方向0：源地址1：目的地址

address_type

否

Integer

地址类型0：ipv4,1:ipv6

address

是

String

ip地址

protocol

否

Integer

协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1

port

否

String

端口

description

否

String

描述

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

data

IdObject object

更新黑白名单响应data
表6 IdObject

参数

参数类型

描述

id

String

id值

name

String

名称

状态码： 400

表7 响应Body参数

参数

参数类型

描述

data

data object

响应体

trace_id

String

trace id
表8 data

参数

参数类型

描述

id

String

标识ID

请求示例

更新项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的白名单为方向为源地址，地址为1.1.1.1，协议类型为tcp，端口为1的ipv4的tcp

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/9d80d070b6d44942af73c9c3d38e042b

{
  "direction" : 0,
  "address" : "1.1.1.1",
  "protocol" : 6,
  "port" : "1",
  "address_type" : 0
}

响应示例

状态码： 200

更新黑白名单响应

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

状态码： 400

Bad Request

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

状态码

状态码

描述

200

更新黑白名单响应

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 黑白名单管理