文档首页/ 数据安全中心 DSC/ API参考/ API/ 态势感知/ 在对应租户下，根据指定条件查询报表信息列表 - ListReport
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

在对应租户下，根据指定条件查询报表信息列表 - ListReport

功能介绍

功能介绍：在对应租户下，根据指定条件查询报表信息列表

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/sdg/reports/list-reports

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"^[a-z0-9]{32}$"

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量

约束限制：

最小值0，最大值2147483647

取值范围：

不涉及

默认取值：

不涉及

limit

否

Integer

参数解释：

每页数量

约束限制：

最小值1，最大值100

取值范围：

不涉及

默认取值：

不涉及

keyword

否

String

参数解释：

关键词

约束限制：

长度0~128字符

取值范围：

不涉及

默认取值：

不涉及

job_id

否

String

参数解释：

报告ID

约束限制：

长度0~1024字符

取值范围：

不涉及

默认取值：

不涉及

task_id

否

String

参数解释：

任务ID

约束限制：

长度0~1024字符

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：

总记录数

取值范围：

不涉及

reports

Array of ReportResultInfo objects

参数解释：

报告列表

取值范围：

不涉及
表5 ReportResultInfo

参数

参数类型

描述

id

String

参数解释：

资源ID，唯一标识

取值范围：

不涉及

name

String

参数解释：

报表名称

取值范围：

不涉及

rule_group_name

String

参数解释：

规则组名称

取值范围：

不涉及

finish_time

Long

参数解释：

完成时间，毫秒级时间戳

取值范围：

不涉及

url

String

参数解释：

报表下载地址

取值范围：

不涉及

format

String

参数解释：

报表格式

取值范围：

不涉及

percentum

Integer

参数解释：

完成百分比

取值范围：

不涉及

task_template_id

String

参数解释：

任务ID

取值范围：

不涉及

task_id

String

参数解释：

任务ID

取值范围：

不涉及

请求示例

请求示例

{
  "offset" : 0,
  "limit" : 10,
  "keyword" : "security-report-202601",
  "job_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
  "task_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46"
}

响应示例

状态码：200

{
  "total" : 2,
  "reports" : [ {
    "id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
    "name" : "security-report-202601",
    "rule_group_name" : "rule-group-encrypt-01",
    "finish_time" : 1700000000000,
    "url" : "https://obs.cn-north-7.example.com/asset-bucket-01",
    "format" : "PDF",
    "percentum" : 100,
    "task_template_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
    "task_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46"
  }, {
    "id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
    "name" : "security-report-202601",
    "rule_group_name" : "rule-group-encrypt-01",
    "finish_time" : 1700000000000,
    "url" : "https://obs.cn-north-7.example.com/asset-bucket-01",
    "format" : "PDF",
    "percentum" : 100,
    "task_template_id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
    "task_id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e"
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

父主题： 态势感知

相关文档