查询访问日志统计信息
功能介绍
获取访问日志的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 |
参数解释: Top命中的阻断策略ID 取值范围: 不涉及 |
deny_top_one_acl_name |
String |
参数解释: Top命中的阻断策略名称 取值范围: 不涉及 |
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" : "时间范围错误" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class ShowAccessTopSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); ShowAccessTopRequest request = new ShowAccessTopRequest(); try { ShowAccessTopResponse response = client.showAccessTop(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowAccessTopRequest() response = client.show_access_top(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowAccessTopRequest{} response, err := client.ShowAccessTop(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。