更新黑白名单列表_黑白名单管理_API_API参考 (联盟区域)

功能介绍

更新黑白名单列表

URI

PUT /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获取。
Content-Type	是	String	内容类型，只有application/json的值是适用的

表4 请求Body参数
参数	是否必选	参数类型	描述
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	更新黑白名单响应数据

表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的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" : "5d37afe6-c5b4-400d-8ff3-a8d6396d7ace",
    "name" : "10.1.1.10"
  }
}