文档首页/云防火墙 CFW/API参考/API/安全报告/查询安全报告发送历史 - ListReportHistory
更新时间：2025-10-20 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询安全报告发送历史 - ListReportHistory

功能介绍

查询安全报告发送历史

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/report/history/{report_profile_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及

report_profile_id

是

String

参数解释：

安全报告模板ID，可以通过调用[查询安全报告模板列表接口]获得，通过返回值中的data.records.profile_id获得

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及

limit

是

Integer

参数解释：

查询返回记录的数量限制

约束限制：

不涉及

取值范围：

1-1024

默认取值：

不涉及

offset

是

Integer

参数解释：

偏移量，表示查询该偏移量后面的记录

约束限制：

不涉及

取值范围：

0 - 1024

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

data

data object

参数解释：

查询报告发送历史数据

取值范围：

不涉及

表4 data

参数

参数类型

描述

limit

Integer

参数解释：

数量限制

取值范围：

不涉及

offset

Integer

参数解释：

偏移量

取值范围：

不涉及

records

Array of ReportHistoryVO objects

参数解释：

发送历史列表

取值范围：

不涉及

total

Integer

参数解释：

总数

取值范围：

不涉及

表5 ReportHistoryVO

参数

参数类型

描述

report_id

String

参数解释：

报告ID

取值范围：

不涉及

send_time

Long

参数解释：

发送时间

取值范围：

不涉及

statistic_period

StatisticPeriod object

参数解释：

统计周期，自定义报告需要设置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

表6 StatisticPeriod

参数

参数类型

描述

end_time

Long

参数解释：

结束时间

约束限制：

不涉及

取值范围：

毫秒级时间戳

默认取值：

不涉及

start_time

Long

参数解释：

结束时间

约束限制：

不涉及

取值范围：

毫秒级时间戳

默认取值：

不涉及

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码

取值范围：

不涉及

error_msg

String

参数解释：

错误描述

取值范围：

不涉及

请求示例

查询安全报告模板发送历史，项目ID为eb7accd78ea845078275b2ad5280a109，防火墙ID为8a996d43-75bd-48b4-b1b8-de0706b72b8f，模板ID为de068699-a2d6-4f3d-8e14-c0ac16ff364e，偏移量为0，返回数量限制为50

https://{Endpoint}/v1/eb7accd78ea845078275b2ad5280a109/report/history/de068699-a2d6-4f3d-8e14-c0ac16ff364e?fw_instance_id=8a996d43-75bd-48b4-b1b8-de0706b72b8f&limit=50&offset=0

响应示例

状态码：200

OK

{
  "data" : {
    "limit" : 0,
    "offset" : 0,
    "records" : [ {
      "report_id" : "b5e342d5-6232-41a1-bed4-162965d43bb8",
      "send_time" : 1751963401402,
      "statistic_period" : {
        "end_time" : 1751903999999,
        "start_time" : 1751817600000
      }
    } ],
    "total" : 27
  }
}

状态码：400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 安全报告

相关文档