# 查询访问控制统计详情 - ShowAccessDetail #### 功能介绍 查询访问控制统计详情 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cfw/cfw_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cfw/cfw_02_0018.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/cfw/logs/top-access-detail 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html) **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | fw_instance_id | 是 | String | **参数解释**： 防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过[防火墙ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0028.html)获取 **约束限制**： 不涉及 **取值范围**： 36位UUID **默认取值**： 不涉及 | | range | 否 | Integer | **参数解释**： 时间范围 **约束限制**： 不涉及 **取值范围**： 0为近一小时 1近一天 2近七天 **默认取值**： 不涉及 | | direction | 否 | String | **参数解释**： 会话方向 **约束限制**： 不涉及 **取值范围**： in2out为出云方向 out2in为入云方向 **默认取值**： 不涉及 | | start_time | 否 | Long | **参数解释**： 开始时间 **约束限制**： 不涉及 **取值范围**： 毫秒级时间戳 **默认取值**： 不涉及 | | end_time | 否 | Long | **参数解释**： 结束时间 **约束限制**： 不涉及 **取值范围**： 毫秒级时间戳 **默认取值**： 不涉及 | | vgw_id | 否 | Array of strings | **参数解释**： VGW ID,虚拟网关ID,可通过调用查询VPN网关列表QueryVPNGateways获取,通过返回值中的vpn_gateways.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 | **参数解释**： 聚合对象 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token，用于携带用户身份信息，配置后可通过接口鉴权，可通过[如何获取用户Token](https://support.huaweicloud.com/api-cfw/cfw_02_0008.html)获取。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [AccessDetailVO] object | | 表5AccessDetailVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | all_session_count | Long | **参数解释**： 所有会话数 **取值范围**： 不涉及 | | session_count | Long | **参数解释**： 会话数 **取值范围**： 不涉及 | | 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数量 **取值范围**： 不涉及 | 表6AccessLogInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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,虚拟网关ID,可通过调用查询VPN网关列表QueryVPNGateways获取,通过返回值中的vpn_gateways.id（.表示各对象之间层级的区分）获得 **取值范围**： 不涉及 | | qos_rule_id | String | | | qos_rule_name | String | | | qos_rule_type | Integer | | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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, "all_session_count" : 3, "records" : [ { "action" : "deny", "app" : "HTTP", "url" : "/index.html", "dst_host" : "www.example.com", "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, "log_id" : "46032", "protocol" : "TCP", "rule_id" : "1ceb7988-b11b-4f1e-b7f1-1a807e9e89f3", "rule_name" : "deny", "rule_type" : 0, "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", "vgw_id" : "", "qos_rule_id" : "", "qos_rule_name" : "", "qos_rule_type" : 0 } ], "rule_hit_count" : 1, "session_count" : 3, "src_ip_count" : 1 } } ``` **状态码：400** Bad Request ``` { "error_code" : "CFW.00200007", "error_msg" : "时间范围错误" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ShowAccessDetailSolution { 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("")) .build(); ShowAccessDetailRequest request = new ShowAccessDetailRequest(); try { ShowAccessDetailResponse response = client.showAccessDetail(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ShowAccessDetailRequest() response = client.show_access_detail(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cfw.CfwClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cfw.NewCfwClient(hcClient) request := &model.ShowAccessDetailRequest{} response, err := client.ShowAccessDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CFW/sdk?api=ShowAccessDetail)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cfw/ErrorCode.html)。