更新时间:2025-08-12 GMT+08:00

查询安全报告

功能介绍

查询安全报告

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/report/{report_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

report_id

String

参数解释

安全报告ID

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

report_profile_id

String

参数解释

安全报告模板ID

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

FirewallReport object

表4 FirewallReport

参数

参数类型

描述

attack_info

AttackReport object

参数解释

安全事件详情

取值范围

不涉及

category

String

参数解释

报告类型

取值范围

不涉及

internet_firewall

InternetReport object

参数解释

互联网边界防火墙

取值范围

不涉及

send_time

Long

参数解释

发送时间

取值范围

不涉及

statistic_period

StatisticPeriod object

参数解释

统计范围

取值范围

不涉及

vpc_firewall

VpcReport object

参数解释

VPC边界防火墙

取值范围

不涉及

表5 AttackReport

参数

参数类型

描述

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攻击分布

取值范围

不涉及

表6 InternetReport

参数

参数类型

描述

eip

Eip object

参数解释

EIP防护情况

取值范围

不涉及

in2out

In2Out object

参数解释

出云流量

取值范围

不涉及

out2in

Out2in object

参数解释

入云流量

取值范围

不涉及

overview

Overview object

参数解释

概览

取值范围

不涉及

traffic_trend

Array of TrendVO objects

参数解释

流量趋势

取值范围

不涉及

表7 Eip

参数

参数类型

描述

protected

ChangedVO object

参数解释

防护情况

取值范围

不涉及

total

Integer

参数解释

EIP数量

取值范围

不涉及

表8 In2Out

参数

参数类型

描述

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

取值范围

不涉及

表9 Out2in

参数

参数类型

描述

dst_ip

Array of ItemVO objects

参数解释

TOP访问目的IP

取值范围

不涉及

dst_port

Array of ItemVO objects

参数解释

TOP开放端口

取值范围

不涉及

src_ip

Array of ItemVO objects

参数解释

TOP访问源IP

取值范围

不涉及

表10 StatisticPeriod

参数

参数类型

描述

end_time

Long

参数解释

结束时间

约束限制

不涉及

取值范围

毫秒级时间戳

默认取值

不涉及

start_time

Long

参数解释

结束时间

约束限制

不涉及

取值范围

毫秒级时间戳

默认取值

不涉及

表11 VpcReport

参数

参数类型

描述

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防护统计

取值范围

不涉及

表12 Overview

参数

参数类型

描述

access_policies

AccessPolicy object

参数解释

访问控制策略

取值范围

不涉及

assets

ChangedVO object

参数解释

资产数量

取值范围

不涉及

attack_event

AttackEvent object

参数解释

威胁事件

取值范围

不涉及

traffic_peak

TrendVO object

参数解释

流量峰值

取值范围

不涉及

表13 AccessPolicy

参数

参数类型

描述

changed

Integer

参数解释

变化数量

取值范围

不涉及

eip

Integer

参数解释

EIP访问控制策略

取值范围

不涉及

nat

Integer

参数解释

NAT访问控制策略

取值范围

不涉及

total

Integer

参数解释

总数

取值范围

不涉及

表14 AttackEvent

参数

参数类型

描述

changed

Integer

参数解释

变化数量

取值范围

不涉及

deny

Integer

参数解释

阻断数量

取值范围

不涉及

total

Integer

参数解释

总数

取值范围

不涉及

表15 TrendVO

参数

参数类型

描述

agg_time

Long

参数解释

聚合时间

取值范围

不涉及

bps

Double

参数解释

带宽

取值范围

不涉及

deny

Long

参数解释

阻断数量

取值范围

不涉及

in_bps

Double

参数解释

入方向bps

取值范围

不涉及

out_bps

Double

参数解释

出方向bps

取值范围

不涉及

permit

Long

参数解释

允许数量

取值范围

不涉及

表16 ItemVO

参数

参数类型

描述

key

String

参数解释

聚合项

取值范围

不涉及

name

String

参数解释

聚合项名称

取值范围

不涉及

value

Long

参数解释

统计值

取值范围

不涉及

表17 Vpc

参数

参数类型

描述

protected

ChangedVO object

参数解释

防护统计

取值范围

不涉及

total

Integer

参数解释

总数

取值范围

不涉及

表18 ChangedVO

参数

参数类型

描述

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",
        "value" : 47
      } ],
      "ips_mode" : 1,
      "level" : [ {
        "key" : "CRITICAL",
        "value" : 119
      } ],
      "rule" : [ {
        "key" : "Realtek Jungle SDK Command Injection Vulnerability (CVE-2021-35394)",
        "value" : 30
      } ],
      "src_ip" : [ {
        "key" : "120.46.56.58",
        "value" : 66
      } ],
      "trend" : [ {
        "agg_time" : 1748966700000,
        "deny" : 2,
        "permit" : 1
      } ],
      "type" : [ {
        "key" : "Vulnerability Exploit Attack",
        "value" : 30
      } ]
    },
    "category" : "custom",
    "internet_firewall" : {
      "eip" : {
        "protected" : {
          "value" : 3
        },
        "total" : 5
      },
      "in2out" : {
        "dst_host" : [ {
          "key" : "repo.huaweicloud.com",
          "value" : 58511700
        } ],
        "dst_port" : [ {
          "key" : "22",
          "value" : 12062960684
        } ],
        "src_ip" : [ {
          "key" : "172.18.0.90",
          "value" : 12062961860
        } ]
      },
      "out2in" : {
        "dst_ip" : [ {
          "key" : "120.46.56.58",
          "value" : 41828474
        } ],
        "dst_port" : [ {
          "key" : "23",
          "value" : 925712
        } ],
        "src_ip" : [ {
          "key" : "114.116.217.114",
          "value" : 4008768
        } ]
      },
      "overview" : {
        "access_policies" : {
          "eip" : 18,
          "nat" : 105,
          "total" : 123
        },
        "assets" : {
          "total" : 5
        },
        "attack_event" : {
          "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",
        "value" : 33901440538
      }, {
        "key" : "PING",
        "value" : 784
      } ],
      "dst_ip" : [ {
        "key" : "172.17.0.192",
        "value" : 33900674752
      }, {
        "key" : "172.18.0.90",
        "value" : 766570
      } ],
      "overview" : {
        "access_policies" : {
          "total" : 10
        },
        "assets" : {
          "total" : 17
        },
        "attack_event" : {
          "deny" : 0,
          "total" : 0
        },
        "traffic_peak" : {
          "bps" : 711475757
        }
      },
      "src_ip" : [ {
        "key" : "172.18.0.90",
        "value" : 33900674752
      }, {
        "key" : "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" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码