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

更新报告

功能介绍

更新报告

调用方法

请参见如何调用API

URI

PUT /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

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

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

report_id

String

报告Id

report_rule_infos

Array of ReportRuleRequest objects

report rules

title

String

邮件标题

to

String

收件人

cc

String

抄送人

subject

String

备注

content

String

邮件内容

report_file_type

String

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

frequency

String

报告发送频率,daily,monthly,weekly

binding_wizard

String

报告页面内容

timezone

String

信息

表4 report_range

参数

是否必选

参数类型

描述

start

String

起始时间

end

String

终止时间

表5 ReportRuleRequest

参数

是否必选

参数类型

描述

rule

String

报告发送任务cron表达式

ruleEnd

String

报告发送任务启动截止时间

start_time

start_time object

报告统计周期的开始时间

end_time

end_time object

报告统计周期的结束时间

表6 start_time

参数

是否必选

参数类型

描述

day

Integer

报告统计周期的日期,前一天为-1,当天为0

week

Integer

报告统计周期的日期,前一周为-1,本周为0

month

Integer

报告统计周期的日期,上一月为-1,本月为0

time

String

报告统计周期的开始,具体时间,时分秒格式

表7 end_time

参数

是否必选

参数类型

描述

day

Integer

报告统计周期的日期,前一天为-1,当天为0

week

Integer

报告统计周期的日期,前一周为-1,本周为0

month

Integer

报告统计周期的日期,上一月为-1,本月为0

time

String

报告统计周期的结束,具体时间,时分秒格式

响应参数

状态码:200

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

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

状态码:400

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

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

表10 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

请求成功

400

请求失败

错误码

请参见错误码

相关文档