查询黑白名单列表
功能介绍
查询黑白名单列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/black-white-lists
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
object_id |
是 |
String |
互联网边界防护对象id，可通过调用查询防火墙实例接口，type为0的为互联网边界防护对象id。 |
|
list_type |
是 |
Integer |
黑白名单类型4：黑名单，5：白名单 |
|
address_type |
否 |
Integer |
IP地址类型0：ipv4,1:ipv6 |
|
address |
否 |
String |
ip地址 |
|
port |
否 |
String |
端口 |
|
limit |
是 |
Integer |
每页显示个数，范围为1-1024 |
|
offset |
是 |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
|
enterprise_project_id |
否 |
String |
企业项目id，用户支持企业项目后，由企业项目生成的id。 |
|
fw_instance_id |
否 |
String |
防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
查询黑白名单返回值 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
offset |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
|
limit |
Integer |
每页显示个数，范围为1-1024 |
|
total |
Integer |
查询的总条数 |
|
records |
Array of records objects |
黑白名单记录 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
list_id |
String |
黑白名单列表id |
|
direction |
Integer |
黑白地址方向0：源地址1：目的地址 |
|
address_type |
Integer |
IP地址类型0：ipv4,1:ipv6 |
|
address |
String |
ip地址 |
|
protocol |
Integer |
协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 |
|
port |
String |
端口 |
|
description |
String |
描述 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
响应体 |
|
trace_id |
String |
trace id |
请求示例
查询项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2第一页的白名单，查询条数为5条
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-lists?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&list_type=5
响应示例
状态码： 200
查询黑白名单列表返回值
{
"data" : {
"limit" : 10,
"offset" : 0,
"records" : [ {
"address" : "1.1.1.1",
"address_type" : 0,
"description" : "",
"direction" : 0,
"list_id" : "1310d401-daf5-44f2-8276-f79e1643984d",
"protocol" : 6
} ],
"total" : 1
}
}
状态码： 400
Bad Request
{
"error_code" : "CFW.0020016",
"error_msg" : "实例状态错误"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询黑白名单列表返回值 |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
