创建黑白名单规则_黑白名单管理_API_API参考（安卡拉区域）

功能介绍

创建黑白名单规则

调用方法

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_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参数
参数	是否必选	参数类型	描述
object_id	是	String	防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用4.1.6 查询防火墙详细信息，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。
list_type	是	Integer	黑白名单类型4：黑名单，5：白名单
list_items	是	Array of list_items objects

表5 list_items
参数	是否必选	参数类型	描述
address	是	String	ip地址
direction	是	Integer	地址方向0：源地址1：目的地址
protocol	是	Integer	协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空
port	是	String	目的端口
description	否	String

响应参数

状态码： 200

表6 响应Body参数
参数	参数类型	描述
data	data object

表7 data
参数	参数类型	描述
duplicated_list	Array of strings	重复ip列表
failed_list	Array of strings	失败列表
responseDatas	Array of responseDatas objects
success_list	Array of success_list objects	成功列表

表8 responseDatas
参数	参数类型	描述
id	String	黑白名单id
name	String	黑白名单地址

表9 success_list
参数	参数类型	描述
address	String	成功的ip地址
address_type	Integer	地址类型
description	String	描述
direction	Integer	方向
port	String	目的端口
protocol	Integer	协议类型

状态码： 400

**表10** 响应Body参数
参数	参数类型	描述
data	data object	响应体
trace_id	String	trace id

**表11** 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

{
  "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2",
  "list_type" : 5,
  "direction" : 0,
  "address" : "1.1.1.1",
  "protocol" : 6,
  "port" : "1",
  "address_type" : 0
}

响应示例

状态码： 200

添加黑白名单响应

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