更新合规报告模版。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ReportTemplateName |
string |
否 |
报告模版名称 |
test-name |
| ReportTemplateId |
string |
是 |
报告模版 Id |
crt-xxx |
| ReportTemplateDescription |
string |
否 |
报告模版描述 |
test-description |
| ReportLanguage |
string |
否 |
报告语言。支持 zh-CN、en-US。空值默认 en-US。 |
en-US |
| ReportGranularity |
string |
否 |
报告聚合粒度。 管理账号视角支持:
成员账号只支持 GroupByAccount。 |
AllInOne |
| ReportFileFormats |
string |
否 |
报告格式 |
excel |
| SubscriptionFrequency |
string |
否 |
报告订阅频率。如果此字段非空,则为订阅通知触发的 Quartz 格式的 Cron 表达式。 格式为:秒 分 时 日 月 周。以下是常用的 Cron 表达式示例:
其中:
说明
触发时间为 UTC+8,可自行根据时区转换 cron 表达式的设置。 说明
只能保证尽量按照 cron 表达式时间进行触发,可能由于报告生产状态有所延迟。cron 表达式会限制同一模版每天最多触发一次通知。 说明
除了用 MON 表示星期一以外,也可以用数字。不过需要注意,在 Quartz 框架中: 1 代表星期日(Sunday);2 代表星期一(Monday);3 代表星期二(Tuesday);4 代表星期三(Wednesday);5 代表星期四(Thursday);6 代表星期五(Friday);7 代表星期六(Saturday) |
0 0 0 * * ? |
| ReportScope |
array<object> |
否 |
报告范围数组,用于选定审计报告中包含的规则范围。数组中每个 ReportScope 之间是或逻辑,也就是加法逻辑。 说明
如数组大小为 2,第一个 ReportScope 指定规则 In cr-1,第二个 ReportScope 指定规则 In cr-2,则此报告圈定的规则范围为 cr-1 和 cr-2。 |
|
|
object |
否 |
报告范围 |
||
| Key |
string |
否 |
报告范围的键,当前支持:
|
RuleId |
| Value |
string |
否 |
报告范围的值。多个同类项,如多个 规则 Id 支持用英文半角逗号(,)分隔。 |
cr-1,cr-2 |
| MatchType |
string |
否 |
匹配逻辑,当前仅支持 In。 |
In |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| ReportTemplateId |
string |
报告模版 Id |
crt-xxx |
| RequestId |
string |
请求 ID。 |
A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7 |
示例
正常返回示例
JSON格式
{
"ReportTemplateId": "crt-xxx",
"RequestId": "A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 服务不可用。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。