创建黑白名单规则_黑白名单管理_API_API参考 (联盟区域)

功能介绍

创建黑白名单规则

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID, 可以从调API处获取，也可以从控制台获取。项目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获取。
Content-Type	是	String	内容类型，只有application/json的值是适用的

表4 请求Body参数
参数	是否必选	参数类型	描述
object_id	是	String	防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得
list_type	是	Integer	黑白名单类型4：黑名单，5：白名单
direction	是	Integer	地址方向0：源地址1：目的地址
address_type	是	Integer	地址Internet协议类型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	BlackWhiteListId object	添加黑白名单响应data

表6 BlackWhiteListId
参数	参数类型	描述
id	String	黑白名单id
name	String	黑白名单名称，为黑白名单的地址

状态码：400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

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

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" : "6e91797b-05bd-4c69-9454-6af905178729",
    "name" : "10.10.1.3"
  }
}