更新报告
功能介绍
更新报告
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/workspaces/{workspace_id}/sa/reports/{report_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
workspace_id |
是 |
String |
参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
report_id |
是 |
String |
报告ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
rule |
否 |
String |
报告发送任务cron表达式 |
ruleEnd |
否 |
String |
报告发送任务启动截止时间 |
start_time |
否 |
start_time object |
报告统计周期的开始时间 |
end_time |
否 |
end_time object |
报告统计周期的结束时间 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
请求成功 |
400 |
请求失败 |
错误码
请参见错误码。