更新时间:2025-08-30 GMT+08:00
分享

获取报告详情

功能介绍

ShowReportInfo

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/workspaces/{workspace_id}/sa/reports/{report_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

report_id

String

报告ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

响应参数

状态码:200

表3 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表4 响应Body参数

参数

参数类型

描述

id

String

报告id

report_name

String

报告名称

report_period

String

报告周期 weekly, daily, annual, monthly

report_range

report_range object

数据范围

language

String

语言

notification_task

String

通知任务id

layout_id

String

布局id

status

String

报告状态 enable, disable

is_generated

Boolean

报告是否已生成

report_rule_infos

Array of ReportRuleInfo objects

report rules

表5 report_range

参数

参数类型

描述

start

String

起始时间

end

String

终止时间

表6 ReportRuleInfo

参数

参数类型

描述

id

String

报告发送规则id

project_id

String

租户ID

workspace_id

String

工作空间ID

cycle

String

数据周期

rule

String

cron表达式

start_time

String

报告数据周期开始时间

end_time

String

报告数据周期结束时间

email_title

String

邮件标题

email_to

String

收件人邮箱

email_content

String

邮件内容

report_file_type

String

报告类型,支持图片、pdf、html

状态码:400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

请求成功

400

请求失败

错误码

请参见错误码

相关文档