# 查询安全报告 - ShowFirewallReport #### 功能介绍 查询安全报告 #### 调用方法 请参见[如何调用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}/report/{report_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html) **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | | report_id | 是 | String | **参数解释**： 安全报告ID，可以通过调用\[查询安全报告发送历史接口\]获得，通过返回值中的data.records.report_id获得 **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | fw_instance_id | 是 | String | **参数解释**： 防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过[防火墙ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0028.html)获取 **约束限制**： 不涉及 **取值范围**： 36位UUID **默认取值**： 不涉及 | | report_profile_id | 是 | String | **参数解释**： 安全报告模板ID **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [FirewallReport] object | | 表4FirewallReport | 参数 | 参数类型 | 描述 | |:---|:---|:---| | attack_info | [AttackReport] object | **参数解释**： 安全事件详情 **取值范围**： 不涉及 | | category | String | **参数解释**： 报告类型 **取值范围**： 不涉及 | | internet_firewall | [InternetReport] object | **参数解释**： 互联网边界防火墙 **取值范围**： 不涉及 | | send_time | Long | **参数解释**： 发送时间 **取值范围**： 不涉及 | | statistic_period | [StatisticPeriod] object | **参数解释**： 统计范围 **取值范围**： 不涉及 | | vpc_firewall | [VpcReport] object | **参数解释**： VPC边界防火墙 **取值范围**： 不涉及 | 表5AttackReport | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dst_ip | Array of [ItemVO] objects | **参数解释**： TOP攻击目的IP **取值范围**： 不涉及 | | ips_mode | Integer | **参数解释**： 入侵防御状态 **取值范围**： 不涉及 | | level | Array of [ItemVO] objects | **参数解释**： 攻击等级分布 **取值范围**： 不涉及 | | rule | Array of [ItemVO] objects | **参数解释**： TOP攻击规则 **取值范围**： 不涉及 | | src_ip | Array of [ItemVO] objects | **参数解释**： TOP来源IP **取值范围**： 不涉及 | | trend | Array of [TrendVO] objects | **参数解释**： 攻击趋势 **取值范围**： 不涉及 | | type | Array of [ItemVO] objects | **参数解释**： TOP攻击分布 **取值范围**： 不涉及 | 表6InternetReport | 参数 | 参数类型 | 描述 | |:---|:---|:---| | eip | [Eip] object | **参数解释**： EIP防护情况 **取值范围**： 不涉及 | | in2out | [In2Out] object | **参数解释**： 出云流量 **取值范围**： 不涉及 | | out2in | [Out2in] object | **参数解释**： 入云流量 **取值范围**： 不涉及 | | overview | [Overview] object | **参数解释**： 概览 **取值范围**： 不涉及 | | traffic_trend | Array of [TrendVO] objects | **参数解释**： 流量趋势 **取值范围**： 不涉及 | 表7Eip | 参数 | 参数类型 | 描述 | |:---|:---|:---| | protected | [ChangedVO] object | **参数解释**： 防护情况 **取值范围**： 不涉及 | | total | Integer | **参数解释**： EIP数量 **取值范围**： 不涉及 | 表8In2Out | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dst_host | Array of [ItemVO] objects | **参数解释**： TOP访问域名 **取值范围**： 不涉及 | | dst_ip | Array of [ItemVO] objects | **参数解释**： TOP访问目的IP **取值范围**： 不涉及 | | dst_port | Array of [ItemVO] objects | **参数解释**： TOP访问端口 **取值范围**： 不涉及 | | src_ip | Array of [ItemVO] objects | **参数解释**： TOP访问源IP **取值范围**： 不涉及 | 表9Out2in | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dst_ip | Array of [ItemVO] objects | **参数解释**： TOP访问目的IP **取值范围**： 不涉及 | | dst_port | Array of [ItemVO] objects | **参数解释**： TOP开放端口 **取值范围**： 不涉及 | | src_ip | Array of [ItemVO] objects | **参数解释**： TOP访问源IP **取值范围**： 不涉及 | 表10StatisticPeriod | 参数 | 参数类型 | 描述 | |:---|:---|:---| | end_time | Long | **参数解释**： 结束时间 **取值范围**： 毫秒级时间戳 | | start_time | Long | **参数解释**： 开始时间 **取值范围**： 毫秒级时间戳 | 表11VpcReport | 参数 | 参数类型 | 描述 | |:---|:---|:---| | app | Array of [ItemVO] objects | **参数解释**： TOP应用数量 **取值范围**： 不涉及 | | dst_ip | Array of [ItemVO] objects | **参数解释**： TOP访问目的IP **取值范围**： 不涉及 | | overview | [Overview] object | **参数解释**： 概览 **取值范围**： 不涉及 | | src_ip | Array of [ItemVO] objects | **参数解释**： TOP访问源IP **取值范围**： 不涉及 | | traffic_trend | Array of [TrendVO] objects | **参数解释**： 流量趋势 **取值范围**： 不涉及 | | vpc | [Vpc] object | **参数解释**： vpc防护统计 **取值范围**： 不涉及 | 表12Overview | 参数 | 参数类型 | 描述 | |:---|:---|:---| | access_policies | [AccessPolicy] object | **参数解释**： 访问控制策略 **取值范围**： 不涉及 | | assets | [ChangedVO] object | **参数解释**： 资产数量 **取值范围**： 不涉及 | | attack_event | [AttackEvent] object | **参数解释**： 威胁事件 **取值范围**： 不涉及 | | traffic_peak | [TrendVO] object | **参数解释**： 流量峰值 **取值范围**： 不涉及 | 表13AccessPolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | changed | Integer | **参数解释**： 变化数量 **取值范围**： 不涉及 | | eip | Integer | **参数解释**： EIP访问控制策略 **取值范围**： 不涉及 | | nat | Integer | **参数解释**： NAT访问控制策略 **取值范围**： 不涉及 | | total | Integer | **参数解释**： 总数 **取值范围**： 不涉及 | 表14AttackEvent | 参数 | 参数类型 | 描述 | |:---|:---|:---| | changed | Integer | **参数解释**： 变化数量 **取值范围**： 不涉及 | | deny | Integer | **参数解释**： 阻断数量 **取值范围**： 不涉及 | | total | Integer | **参数解释**： 总数 **取值范围**： 不涉及 | 表15TrendVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | agg_time | Long | **参数解释**： 聚合时间 **取值范围**： 不涉及 | | bps | Double | **参数解释**： 带宽 **取值范围**： 不涉及 | | deny | Long | **参数解释**： 阻断数量 **取值范围**： 不涉及 | | in_bps | Double | **参数解释**： 入方向bps **取值范围**： 不涉及 | | out_bps | Double | **参数解释**： 出方向bps **取值范围**： 不涉及 | | permit | Long | **参数解释**： 允许数量 **取值范围**： 不涉及 | 表16ItemVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 聚合项 **取值范围**： 不涉及 | | name | String | **参数解释**： 聚合项名称 **取值范围**： 不涉及 | | value | Long | **参数解释**： 统计值 **取值范围**： 不涉及 | 表17Vpc | 参数 | 参数类型 | 描述 | |:---|:---|:---| | protected | [ChangedVO] object | **参数解释**： 防护统计 **取值范围**： 不涉及 | | total | Integer | **参数解释**： 总数 **取值范围**： 不涉及 | 表18ChangedVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | changed | Integer | **参数解释**： 变化数量 **取值范围**： 不涉及 | | total | Integer | **参数解释**： 变化数量 **取值范围**： 不涉及 | | value | Integer | **参数解释**： 数量 **取值范围**： 不涉及 | **状态码：400** 表19响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述 **取值范围**： 不涉及 | #### 请求示例 项目ID为eb7accd78ea845078275b2ad5280a109，防火墙ID为8a996d43-75bd-48b4-b1b8-de0706b72b8f, 模板ID为e8f43868-d6e7-43a7-aa7f-dda0292f4785，报告ID为b07861af-3468-4d4e-b39b-30c9ca516888，查询安全报告 ``` https://{Endpoint}/v1/eb7accd78ea845078275b2ad5280a109/report/b07861af-3468-4d4e-b39b-30c9ca516888?report_profile_id=e8f43868-d6e7-43a7-aa7f-dda0292f4785&fw_instance_id=8a996d43-75bd-48b4-b1b8-de0706b72b8f ``` #### 响应示例 **状态码：200** OK ``` { "data" : { "attack_info" : { "dst_ip" : [ { "key" : "120.52.95.246", "name" : "120.52.95.246", "value" : 47 } ], "ips_mode" : 1, "level" : [ { "key" : "CRITICAL", "name" : "CRITICAL", "value" : 119 } ], "rule" : [ { "key" : "Realtek Jungle SDK Command Injection Vulnerability (CVE-2021-35394)", "name" : "Realtek Jungle SDK Command Injection Vulnerability (CVE-2021-35394)", "value" : 30 } ], "src_ip" : [ { "key" : "120.46.56.58", "name" : "120.46.56.58", "value" : 66 } ], "trend" : [ { "agg_time" : 1748966700000, "deny" : 2, "in_bps" : 125.5, "out_bps" : 89.3, "permit" : 1 } ], "type" : [ { "key" : "Vulnerability Attack", "name" : "Vulnerability Attack", "value" : 30 } ] }, "category" : "custom", "internet_firewall" : { "eip" : { "protected" : { "value" : 3 }, "total" : 5 }, "in2out" : { "dst_ip" : [ { "key" : "120.52.95.246", "name" : "120.52.95.246", "value" : 47 } ], "dst_host" : [ { "key" : "repo.huaweicloud.com", "name" : "repo.huaweicloud.com", "value" : 58511700 } ], "dst_port" : [ { "key" : "22", "name" : "22", "value" : 12062960684 } ], "src_ip" : [ { "key" : "172.18.0.90", "name" : "172.18.0.90", "value" : 12062961860 } ] }, "out2in" : { "dst_ip" : [ { "key" : "120.46.56.58", "name" : "120.46.56.58", "value" : 41828474 } ], "dst_port" : [ { "key" : "23", "name" : "23", "value" : 925712 } ], "src_ip" : [ { "key" : "114.116.217.114", "name" : "114.116.217.114", "value" : 4008768 } ] }, "overview" : { "access_policies" : { "changed" : 5, "eip" : 18, "nat" : 105, "total" : 123 }, "assets" : { "total" : 5 }, "attack_event" : { "changed" : 3, "deny" : 30, "total" : 119 }, "traffic_peak" : { "in_bps" : 2381284, "out_bps" : 3977 } }, "traffic_trend" : [ { "agg_time" : 1748966400000, "bps" : 0, "in_bps" : 3238, "out_bps" : 808 } ] }, "send_time" : 1749698298872, "statistic_period" : { "end_time" : 1749657599999, "start_time" : 1748966400000 }, "vpc_firewall" : { "app" : [ { "key" : "SSH", "name" : "SSH", "value" : 33901440538 }, { "key" : "PING", "name" : "PING", "value" : 784 } ], "dst_ip" : [ { "key" : "172.17.0.192", "name" : "172.17.0.192", "value" : 33900674752 }, { "key" : "172.18.0.90", "name" : "172.18.0.90", "value" : 766570 } ], "overview" : { "access_policies" : { "changed" : 2, "eip" : 5, "nat" : 5, "total" : 10 }, "assets" : { "total" : 17 }, "attack_event" : { "changed" : 0, "deny" : 0, "total" : 0 }, "traffic_peak" : { "bps" : 711475757 } }, "src_ip" : [ { "key" : "172.18.0.90", "name" : "172.18.0.90", "value" : 33900674752 }, { "key" : "172.17.0.192", "name" : "172.17.0.192", "value" : 766570 } ], "traffic_trend" : [ { "agg_time" : 1748966400000, "bps" : 0, "in_bps" : 0, "out_bps" : 0 } ], "vpc" : { "protected" : { "value" : 2 }, "total" : 17 } } } } ``` **状态码：400** Bad Request ``` { "error_code" : "CFW.00200003", "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 ShowFirewallReportSolution { 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(); ShowFirewallReportRequest request = new ShowFirewallReportRequest(); request.withReportId("{report_id}"); try { ShowFirewallReportResponse response = client.showFirewallReport(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 = ShowFirewallReportRequest() request.report_id = "{report_id}" response = client.show_firewall_report(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.ShowFirewallReportRequest{} request.ReportId = "{report_id}" response, err := client.ShowFirewallReport(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=ShowFirewallReport)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cfw/ErrorCode.html)。