查询访问日志统计信息
功能介绍
获取访问日志的TOP统计信息，如TOP命中规则等
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/cfw/logs/access-top
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。项目ID获取方式 约束限制： 不涉及 取值范围： 32位UUID 默认取值： 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
fw_instance_id |
是 |
String |
参数解释： 防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过防火墙ID获取方式获取 约束限制： 不涉及 取值范围： 32位UUID 默认取值： 不涉及 |
|
range |
否 |
Integer |
参数解释： 时间范围 约束限制： 不涉及 取值范围： 0为近一时 1近一天 2近七天 默认取值： 不涉及 |
|
direction |
否 |
String |
参数解释： 会话方向 约束限制： 不涉及 取值范围： in2out为出云方向 out2in为入云方向 默认取值： 不涉及 |
|
start_time |
否 |
Long |
参数解释： 开始时间 约束限制： 不涉及 取值范围： 毫秒级时间戳 默认取值： 不涉及 |
|
end_time |
否 |
Long |
参数解释： 结束时间 约束限制： 不涉及 取值范围： 毫秒级时间戳 默认取值： 不涉及 |
|
vgw_id |
否 |
Array of strings |
参数解释： VGW ID 约束限制： 不涉及 取值范围： 32位UUID 默认取值： 不涉及 |
|
log_type |
否 |
String |
参数解释： 日志类型 约束限制： 不涉及 取值范围： internet为南北向日志、nat为nat场景日志，vpc为东西向日志，vgw为vgw场景日志 默认取值： 不涉及 |
|
item |
是 |
String |
参数解释： 聚合类型 约束限制： 不涉及 取值范围： strategy_hit_info 策略的命中趋势 strategy_dashboard 策略命中概览 top_deny_rule TOP命中拦截策略 dst_ip TOP拦截目的IP src_ip TOP拦截源IP dst_port TOP拦截端口 dst_region TOP拦截目的地区 src_region TOP拦截源地区 默认取值： 不涉及 |
|
rule_id |
否 |
Array of strings |
参数解释： 规则ID列表 约束限制： 不涉及 取值范围： 32位UUID 默认取值： 不涉及 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
AccessTopVO object |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
deny_count |
Long |
参数解释： 阻断次数 取值范围： 不涉及 |
|
deny_top_one_acl_id |
String |
参数解释： 高频命中的阻断策略ID 取值范围： 不涉及 |
|
deny_top_one_acl_name |
String |
参数解释： 高频命中的阻断策略ID 取值范围： 不涉及 |
|
hit_count |
Long |
参数解释： 命中次数 取值范围： 不涉及 |
|
in2out_deny_dst_ip_list |
Array of AccessTopMemberVO objects |
参数解释： TOP出云阻断目的IP列表 取值范围： 不涉及 |
|
in2out_deny_dst_port_list |
Array of AccessTopMemberVO objects |
参数解释： TOP出云阻断端口列表 取值范围： 不涉及 |
|
in2out_deny_dst_region_list |
Array of AccessTopMemberVO objects |
参数解释： TOP出云阻断目的地区列表 取值范围： 不涉及 |
|
in2out_deny_src_ip_list |
Array of AccessTopMemberVO objects |
参数解释： TOP出云阻断源IP列表 取值范围： 不涉及 |
|
out2in_deny_dst_ip_list |
Array of AccessTopMemberVO objects |
参数解释： TOP入云阻断目的IP列表 取值范围： 不涉及 |
|
out2in_deny_dst_port_list |
Array of AccessTopMemberVO objects |
参数解释： TOP入云阻断目的端口列表 取值范围： 不涉及 |
|
out2in_deny_src_ip_list |
Array of AccessTopMemberVO objects |
参数解释： TOP入云阻断源IP列表 取值范围： 不涉及 |
|
out2in_deny_src_port_list |
Array of AccessTopMemberVO objects |
参数解释： TOP入云阻断源端口列表 取值范围： 不涉及 |
|
out2in_deny_src_region_list |
Array of AccessTopMemberVO objects |
参数解释： TOP入云阻断源地区列表 取值范围： 不涉及 |
|
permit_count |
Long |
参数解释： 放行次数 取值范围： 不涉及 |
|
permit_top_one_acl_id |
String |
参数解释： 高频命中的放行策略ID 取值范围： 不涉及 |
|
permit_top_one_acl_name |
String |
参数解释： 高频命中的放行策略名称 取值范围： 不涉及 |
|
records |
Array of AccessTopStatisticsVO objects |
参数解释： 命中趋势 取值范围： 不涉及 |
|
top_deny_rule_list |
Array of AccessTopMemberVO objects |
参数解释： TOP阻断规则列表 取值范围： 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
agg_time |
Long |
参数解释： 聚合时间 取值范围： 不涉及 |
|
deny_access_top_counts |
Long |
参数解释： 阻断数量 取值范围： 不涉及 |
|
permit_access_top_counts |
Long |
参数解释： 放行数量 取值范围： 不涉及 |
|
total_access_top_counts |
Long |
参数解释： 命中次数 取值范围： 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
String |
参数解释： 次数 取值范围： 不涉及 |
|
item |
String |
参数解释： 项 取值范围： 不涉及 |
|
name |
String |
参数解释： 项名称 取值范围： 不涉及 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码 取值范围： 不涉及 |
|
error_msg |
String |
参数解释： 错误描述 取值范围： 不涉及 |
请求示例
查询项目ID为a16df7cf1d094befa6bbc72cbf51e93a防火墙ID为c598d612-8112-465c-bffd-863d4ce85a50时间范围为1小时的策略概览
https://{Endpoint}/v1/a16df7cf1d094befa6bbc72cbf51e93a/cfw/logs/access-top?fw_instance_id=a7df0f6c-da03-4511-ad0b-b17b589ff0ec&item=strategy_dashboard&range=0响应示例
状态码：200
OK
{
"data" : {
"deny_count" : 27,
"deny_top_one_acl_id" : "1ceb7988-b11b-4f1e-b7f1-1a807e9e89f3",
"deny_top_one_acl_name" : "deny",
"hit_count" : 4404,
"permit_count" : 4377,
"permit_top_one_acl_id" : "d1de06f0-dfe1-46e5-a50d-81a423b157a8",
"permit_top_one_acl_name" : "23333"
}
}状态码：400
Bad Request
{
"error_code" : "CFW.00200007",
"error_msg" : "时间范围错误"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
错误码
请参见错误码。
