查询访问控制统计详情
功能介绍
查询访问控制统计详情
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/cfw/logs/top-access-detail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
参数解释: 聚合类型 约束限制: 不涉及 取值范围: top_deny_rule 命中拦截策略 dst_ip 拦截目的IP src_ip 拦截源IP dst_port 拦截端口 dst_region 拦截目的地区 src_region 拦截源地区 默认取值: 不涉及 |
item_id |
是 |
String |
参数解释: 聚合对象 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
AccessDetailVO object |
参数 |
参数类型 |
描述 |
---|---|---|
dst_ip_count |
Long |
参数解释: 目的IP数量 取值范围: 不涉及 |
dst_port_count |
Long |
参数解释: 目的端口数量 取值范围: 不涉及 |
hit_count |
Long |
参数解释: 命中次数 取值范围: 不涉及 |
protocol_count |
Long |
参数解释: 协议数量 取值范围: 不涉及 |
recent_end_time |
Long |
参数解释: 结束时间 取值范围: 不涉及 |
recent_start_time |
Long |
参数解释: 开始时间 取值范围: 不涉及 |
record_total |
Long |
参数解释: 记录数量 取值范围: 不涉及 |
records |
Array of AccessLogInfo objects |
参数解释: 命中详情 取值范围: 不涉及 |
rule_hit_count |
Long |
参数解释: 命中规则数 取值范围: 不涉及 |
src_ip_count |
Long |
参数解释: 源IP数量 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
action |
String |
参数解释: 动作 取值范围: 不涉及 |
app |
String |
参数解释: 应用 取值范围: 不涉及 |
url |
String |
|
dst_host |
String |
参数解释: 目的域名 取值范围: 不涉及 |
dst_ip |
String |
参数解释: 目的IP 取值范围: 不涉及 |
dst_port |
Integer |
参数解释: 目的端口 取值范围: 不涉及 |
dst_region_id |
String |
参数解释: 目的地区ID 取值范围: 不涉及 |
dst_region_name |
String |
参数解释: 目的地区名称 取值范围: 不涉及 |
dst_province_id |
String |
参数解释: 目的省份ID 取值范围: 不涉及 |
dst_province_name |
String |
参数解释: 目的省份名称 取值范围: 不涉及 |
dst_city_id |
String |
参数解释: 目的城市ID 取值范围: 不涉及 |
dst_city_name |
String |
参数解释: 目的城市名称 取值范围: 不涉及 |
hit_time |
Long |
参数解释: 命中时间 取值范围: 不涉及 |
log_id |
String |
|
protocol |
String |
参数解释: 协议 取值范围: 不涉及 |
rule_id |
String |
参数解释: 规则ID 取值范围: 不涉及 |
rule_name |
String |
参数解释: 规则名称 取值范围: 不涉及 |
rule_type |
Integer |
|
src_ip |
String |
参数解释: 源IP 取值范围: 不涉及 |
src_port |
Integer |
参数解释: 源端口 取值范围: 不涉及 |
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 |
参数解释: VGW ID 取值范围: 不涉及 |
qos_rule_id |
String |
|
qos_rule_name |
String |
|
qos_rule_type |
Integer |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
查询项目ID为7db2c6e2934046dd8c5a996ed4780c5b防火墙ID为a7df0f6c-da03-4511-ad0b-b17b589ff0ec时间范围为1小时,IP为59.39.0.152的出云拦截详情
v1/7db2c6e2934046dd8c5a996ed4780c5b/cfw/logs/top-access-detail?fw_instance_id=a7df0f6c-da03-4511-ad0b-b17b589ff0ec&item=dst_ip&range=0&direction=in2out&item_id=59.39.0.152
响应示例
状态码:200
OK
{ "data" : { "dst_ip_count" : 1, "dst_port_count" : 1, "hit_count" : 3, "protocol_count" : 1, "recent_end_time" : 1751545553000, "recent_start_time" : 1751545469000, "record_total" : 3, "records" : [ { "action" : "deny", "app" : "HTTP", "dst_ip" : "59.39.0.152", "dst_port" : 80, "dst_region_id" : "CN", "dst_region_name" : "中国", "dst_province_id" : "GD", "dst_province_name" : "Guangdong", "dst_city_id" : "Foshan", "dst_city_name" : "Foshan", "hit_time" : 1751545498000, "protocol" : "TCP", "rule_id" : "1ceb7988-b11b-4f1e-b7f1-1a807e9e89f3", "rule_name" : "deny", "src_ip" : "121.37.223.24", "src_port" : 39948, "src_region_id" : "CN", "src_region_name" : "中国", "src_province_id" : "GD", "src_province_name" : "Guangdong", "src_city_id" : "Guangzhou", "src_city_name" : "Guangzhou" } ], "rule_hit_count" : 1, "src_ip_count" : 1 } }
状态码:400
Bad Request
{ "error_code" : "CFW.00200007", "error_msg" : "时间范围错误" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。