查询流日志
功能介绍
查询流日志
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/cfw/logs/flow
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
fw_instance_id |
是 |
String |
防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口。 |
|
direction |
否 |
String |
方向，包含in2out，out2in |
|
log_type |
否 |
String |
日志类型包括：internet，vpc，nat |
|
start_time |
是 |
Long |
开始时间，以毫秒为单位的时间戳，如1718936272648 |
|
end_time |
是 |
Long |
结束时间，以毫秒为单位的时间戳，如1718936272648 |
|
src_ip |
否 |
String |
源IP |
|
src_port |
否 |
Integer |
源端口 |
|
dst_ip |
否 |
String |
目的IP |
|
dst_port |
否 |
Integer |
目的端口 |
|
protocol |
否 |
String |
协议类型，包含TCP, UDP,ICMP,ICMPV6等。 |
|
app |
否 |
String |
应用协议 |
|
log_id |
否 |
String |
文档ID,第一页为空，其他页不为空，其他页可取上一次查询最后一条数据的log_id |
|
next_date |
否 |
Long |
下个日期，当是第一页时为空，不是第一页时不为空，其他页可取上一次查询最后一条数据的start_time |
|
offset |
否 |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于0，首页时为空，非首页时不为空 |
|
limit |
是 |
Integer |
每页显示个数，范围为1-1024 |
|
enterprise_project_id |
否 |
String |
企业项目id，用户支持企业项目后，由企业项目生成的id。 |
|
dst_host |
否 |
String |
目的主机 |
|
src_region_name |
否 |
String |
源region名称 |
|
dst_region_name |
否 |
String |
目的region名称 |
|
src_province_name |
否 |
String |
源省份名称 |
|
dst_province_name |
否 |
String |
目的省份名称 |
|
src_city_name |
否 |
String |
源城市名称 |
|
dst_city_name |
否 |
String |
目的城市名称 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
查询流日志返回值 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
返回数量 |
|
limit |
Integer |
每页显示个数，范围为1-1024 |
|
records |
Array of records objects |
记录 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
bytes |
Double |
字节 |
|
direction |
String |
方向，有内到外和外到内两种 |
|
packets |
Integer |
包 |
|
start_time |
Long |
开始时间，以毫秒为单位的时间戳，如1718936272648 |
|
end_time |
Long |
结束时间，以毫秒为单位的时间戳，如1718936272648 |
|
log_id |
String |
文档ID |
|
src_ip |
String |
源IP |
|
src_port |
Integer |
源端口 |
|
dst_ip |
String |
目的IP |
|
app |
String |
应用协议 |
|
dst_port |
Integer |
目的端口 |
|
protocol |
String |
协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 |
|
dst_host |
String |
目标主机 |
|
dst_region_id |
String |
目的地域id |
|
dst_region_name |
String |
目的地域名称 |
|
src_region_id |
String |
源地域id |
|
src_region_name |
String |
源地域名称 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
响应体 |
|
trace_id |
String |
trace id |
请求示例
查询项目id为9d80d070b6d44942af73c9c3d38e0429防火墙id为2af58b7c-893c-4453-a984-bdd9b1bd6318，起点时间为1663555012000，终点时间为1664159798000的首页的流日志。
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/cfw/logs/flow?fw_instance_id=2af58b7c-893c-4453-a984-bdd9b1bd6318&start_time=1663555012000&end_time=1664159798000&limit=10
响应示例
状态码： 200
OK
{
"data" : {
"limit" : 10,
"records" : [ {
"app" : "PING",
"bytes" : 0.765625,
"direction" : "in2out",
"dst_ip" : "133.31.112.5(Japan)",
"end_time" : 1721381276000,
"log_id" : "50418",
"packets" : 1,
"protocol" : "ICMP: ECHO_REQUEST",
"src_ip" : "143.16.88.198(United States of America)",
"start_time" : 1721381268000,
"dst_region_id" : "JP",
"dst_region_name" : "Japan",
"src_region_id" : "US",
"src_region_name" : "United States of America"
} ],
"total" : 1
}
}
状态码： 400
Bad Request
{
"error_code" : "CFW.00500002",
"error_msg" : "时间间距错误"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
