查询防火墙日志
功能介绍
查询防火墙日志
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/cfw/{fw_instance_id}/logs
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
filters |
否 |
Array of Filter objects |
参数解释: 过滤条件 约束限制: 不涉及 取值范围: 1-1024 默认取值: 不涉及 |
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 1-1024 默认取值: 不涉及 |
offset |
否 |
Integer |
参数解释: 偏移量 约束限制: 第一页为空,其他页不为空 取值范围: 相对于上一页的偏移量 默认取值: 不涉及 |
log_id |
否 |
String |
参数解释: 文档ID 约束限制: 第一页为空,其他页不为空 取值范围: 上一次查询最后一条数据的log_id 默认取值: 不涉及 |
next_date |
否 |
Long |
参数解释: 下个日期 约束限制: 第一页为空,其他页不为空 取值范围: 查询流量日志时为上一次查询最后一条数据的end_time 默认取值: 不涉及 |
start_time |
是 |
Long |
参数解释: 开始时间 约束限制: 不涉及 取值范围: 毫秒级时间戳 默认取值: 不涉及 |
end_time |
是 |
Long |
参数解释: 结束时间 约束限制: 不涉及 取值范围: 毫秒级时间戳 默认取值: 不涉及 |
log_type |
是 |
String |
参数解释: 日志类型 约束限制: 不涉及 取值范围: internet为南北向日志、nat为nat场景日志,vpc为东西向日志,vgw为vgw场景日志 默认取值: 不涉及 |
type |
是 |
String |
参数解释: 日志类型 约束限制: 不涉及 取值范围: attack为攻击日志、acl 访问控制日志,flow 流量日志,url url日志 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
参数解释: 日志 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
limit |
Integer |
参数解释: 条数 取值范围: 不涉及 |
records |
Array of LogVO objects |
参数解释: 日志 取值范围: 不涉及 |
total |
Long |
参数解释: 记录总数 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
app |
String |
参数解释: 应用 取值范围: 不涉及 |
bytes |
Double |
参数解释: 流字节数,流量日志字段 取值范围: 不涉及 |
direction |
String |
参数解释: 会话方向 取值范围: out2in 外到内访问 in2out 内到外访问 |
dst_host |
String |
参数解释: 流字节数,访问控制日志和流量日志中存在 取值范围: 目的网址 |
dst_ip |
String |
参数解释: 目的IP 取值范围: 不涉及 |
dst_port |
Integer |
参数解释: 目的端口 取值范围: 不涉及 |
end_time |
Long |
参数解释: 会话结束时间,流量日志字段 取值范围: 不涉及 |
log_id |
String |
参数解释: 日志ID,用于分页查询 取值范围: 不涉及 |
packets |
Double |
参数解释: 流包数,流量日志字段 取值范围: 不涉及 |
protocol |
String |
参数解释: 协议 取值范围: 不涉及 |
src_ip |
String |
参数解释: 源Ip 取值范围: 不涉及 |
src_port |
Integer |
参数解释: 源端口 取值范围: 不涉及 |
start_time |
Long |
参数解释: 会话开始时间,流量日志字段 取值范围: 不涉及 |
dst_region_id |
AnyType |
参数解释: 目的地区ID 取值范围: 不涉及 |
dst_region_name |
String |
参数解释: 目的地区名称 取值范围: 不涉及 |
dst_province_id |
String |
参数解释: 目的省份ID 取值范围: 不涉及 |
dst_province_name |
String |
参数解释: 目的省份名称 取值范围: 不涉及 |
dst_city_id |
String |
参数解释: 目的城市ID 取值范围: 不涉及 |
dst_city_name |
String |
参数解释: 目的城市名称 取值范围: 不涉及 |
src_region_id |
String |
参数解释: 源地区ID 取值范围: 不涉及 |
src_region_name |
String |
参数解释: 源地区名称 取值范围: 不涉及 |
src_province_id |
String |
参数解释: 源省份ID 取值范围: 不涉及 |
src_province_name |
String |
参数解释: 源省份名称 取值范围: 不涉及 |
src_city_id |
String |
参数解释: 源城市ID 取值范围: 不涉及 |
src_city_name |
String |
参数解释: 源城市名称 取值范围: 不涉及 |
vgw_id |
String |
参数解释: 虚拟网关ID 取值范围: 不涉及 |
sctp_verification_tag |
Long |
参数解释: sctp验证标签,流量日志字段 取值范围: 不涉及 |
sctp_is_handshake_flow |
String |
参数解释: sctp握手流,流量日志字段 取值范围: 不涉及 |
qos_rule_id |
String |
参数解释: qos规则ID,流量日志、访问控制日志存在 取值范围: 不涉及 |
qos_rule_name |
String |
参数解释: qos规则名称,流量日志、访问控制日志存在 取值范围: 不涉及 |
qos_channel_id |
String |
参数解释: qos通道ID,流量日志字段 取值范围: 不涉及 |
qos_channel_name |
String |
参数解释: qos通道名称,流量日志字段 取值范围: 不涉及 |
qos_drop_packets |
Double |
参数解释: qos丢包数,流量日志字段 取值范围: 不涉及 |
qos_drop_bytes |
Double |
参数解释: qos丢弃字节,流量日志字段 取值范围: 不涉及 |
qos_rule_type |
Integer |
参数解释: qos规则类型,流量日志、访问控制日志存在 取值范围: 不涉及 |
qos_channel_type |
Integer |
参数解释: qos通道类型,流量日志字段 取值范围: 不涉及 |
action |
String |
参数解释: 动作,攻击日志、访问控制日志、URL日志存在 取值范围: 不涉及 |
url |
String |
参数解释: url,URL日志字段 取值范围: 不涉及 |
hit_time |
Long |
参数解释: 命中时间,访问控制日志、URL日志存在 取值范围: 不涉及 |
rule_id |
String |
参数解释: 规则ID,访问控制日志、URL日志存在 取值范围: 不涉及 |
rule_name |
String |
参数解释: 规则名称,访问控制日志、URL日志存在 取值范围: 不涉及 |
rule_type |
Integer |
参数解释: 规则类型,访问控制日志和URL日志字段 取值范围: 不涉及 |
attack_rule |
String |
参数解释: 规则类型,攻击日志字段 取值范围: 不涉及 |
attack_rule_id |
String |
参数解释: 攻击规则ID,攻击日志字段 取值范围: 不涉及 |
attack_type |
String |
参数解释: 攻击类型,攻击日志字段 取值范围: 不涉及 |
event_time |
Long |
参数解释: 事件时间,攻击日志字段 取值范围: 不涉及 |
level |
String |
参数解释: 攻击等级,攻击日志字段 取值范围: 不涉及 |
packet |
String |
参数解释: 规则载荷,攻击日志字段 取值范围: 不涉及 |
source |
String |
参数解释: 攻击来源,攻击日志字段 取值范围: 不涉及 |
real_ip |
String |
参数解释: 真实IP,攻击日志字段 取值范围: 不涉及 |
tag |
Integer |
参数解释: 标签类型,攻击日志字段 取值范围: 1 WAF回源IP |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
项目ID为a16df7cf1d094befa6bbc72cbf51e93a,防火墙ID为fcd04edd-428a-4631-bef5-46a924293cca,时间范围为1751952647737到1751963447737,查询数量1000条,过滤条件为目的IP为方向为100.85.219.117,查询互联网边界的流量日志
https://{Endpoint}//v1/a16df7cf1d094befa6bbc72cbf51e93a/cfw/fcd04edd-428a-4631-bef5-46a924293cca/logs { "limit" : 1000, "filters" : [ { "field" : "dst_ip", "operator" : "equal", "values" : [ "100.85.219.117" ] } ], "start_time" : 1751952647737, "end_time" : 1751963447737, "log_type" : "internet", "type" : "flow" }
响应示例
状态码:200
OK
{ "data" : { "limit" : 1000, "records" : [ { "app" : "DNS", "bytes" : 87, "direction" : "in2out", "dst_ip" : "100.85.219.117", "dst_port" : 53, "end_time" : 1751963431000, "log_id" : "73861", "packets" : 1, "protocol" : "UDP", "src_ip" : "100.93.2.30", "src_port" : 55637, "start_time" : 1751963369000 } ], "total" : 1 } }
状态码:400
Bad Request
{ "error_code" : "CFW.00200003", "error_msg" : "参数错误" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。