查询报告总览页列表 - ListSecurityReport

功能介绍

查询报告总览页列表

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v5/{project_id}/report/report-list

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。约束限制: 不涉及取值范围: 字符长度1-256位默认取值: 不涉及

表2 Query参数
参数	是否必选	参数类型	描述
enterprise_project_id	否	String	参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。如需查询所有企业项目下的资产请传参“all_granted_eps”。约束限制: 开通企业项目功能后才需要配置企业项目ID参数。取值范围: 字符长度1-256位默认取值: 0，表示默认企业项目（default）。
report_category	否	String	参数解释: "报告类别(不传默认是全部)" 约束限制: 不涉及取值范围: daily_report：安全日报 weekly_report：安全周报 monthly_report：安全月报 custom_report：自定义报告默认取值: 不涉及，不传默认是全部
offset	否	Integer	参数解释: 偏移量：指定返回记录的开始位置约束限制: 不涉及取值范围: 最小值0，最大值2000000 默认取值: 默认为0
limit	否	Integer	参数解释: 每页显示个数约束限制: 不涉及取值范围: 取值10-200 默认取值: 10

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。约束限制: 不涉及取值范围: 字符长度1-32768位默认取值: 不涉及
region	否	String	参数解释: 区域ID，用于查询目的区域内的资产。获取方式请参见获取区域ID。约束限制: 不涉及取值范围: 字符长度1-128位默认取值: 不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
total_num	Integer	参数解释: 总数取值范围: 最小值0，最大值2147483647
data_list	Array of SecurityReportResponseInfo objects	参数解释: 报告总览页列表取值范围: 最少0条，最多2147483647条

表5 SecurityReportResponseInfo
参数	参数类型	描述
report_id	Integer	参数解释: 报告ID 取值范围: 字符长度10-2147483647位
report_sub_id	Integer	参数解释: 报告子ID 取值范围: 字符长度10-2147483647位
default_report	Boolean	参数解释: 是否是默认的，默认的不能删除取值范围: true ：是。 false ：否。
latest_create_time	Integer	参数解释：最近生成时间，毫秒(如果返回值为null，代表暂未生成) 取值范围: 不涉及
report_name	String	参数解释: 报告名称取值范围: 字符长度1-128位
report_category	String	参数解释: 报告类别取值范围: daily_report：安全日报 weekly_report：安全周报 monthly_report：安全月报 custom_report：自定义报告
report_status	String	参数解释: 报告开启状态取值范围: opened：开启 closed：关闭
report_create_time	Integer	参数解释：报告创建时间取值范围: 不涉及
sending_period	String	参数解释: 报告发送的时间段取值范围: morning：代表0点到6点 noon：代表6点到12点 afternoon：代表12点到18点 evening：代表18点到24点

请求示例

无

响应示例

状态码：200

请求已成功

{
  "report_id" : 444,
  "report_sub_id" : 555,
  "default_report" : true,
  "report_name" : "ywk测试非所有企业项目",
  "report_category" : "custom_report",
  "report_status" : "opened",
  "report_create_time" : 1744512829390,
  "latest_create_time" : 1774196836964
}