All Products
Search

This Product

    Cloud Config:UpdateReportTemplate

    Document Center

    Cloud Config:UpdateReportTemplate

    Last Updated:Feb 06, 2026

    Updates a compliance report template.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ReportTemplateName

    string

    No

    The name of the report template.

    test-name
    ReportTemplateId

    string

    Yes

    The ID of the report template.

    crt-xxx
    ReportTemplateDescription

    string

    No

    The description of the report template.

    test-description
    ReportLanguage

    string

    No

    The language of the report. Valid values: zh-CN and en-US. If you leave this parameter empty, the default value en-US is used.

    en-US
    ReportGranularity

    string

    No

    The aggregation granularity of the report.

    For a management account, the following values are supported:

    • AllInOne: A single report is generated for all accounts within the template scope.

    • GroupByAggregator: Reports are aggregated by account group. A compressed file is generated.

    • GroupByAccount: A separate report is generated for each account. This is the default value. A compressed file is generated.

    For a member account, only GroupByAccount is supported.

    AllInOne
    ReportFileFormats

    string

    No

    The format of the report.

    excel
    SubscriptionFrequency

    string

    No

    The frequency for subscribing to the report. If this parameter is not empty, it specifies a cron expression in the Quartz format that triggers a subscription notification.

    The format is: Second Minute Hour Day Month Week. The following list provides common examples of cron expressions:

    • To run at 00:00 every day: 0 0 0 * * ?

    • To run at 15:30 every Monday: 0 30 15 ? * MON

    • To run at 02:00 on the first day of every month: 0 0 2 1 * ?

    Where:

    • "*" indicates any value.

    • ? is used in the Day and Week fields and indicates that no specific value is specified.

    • MON indicates Monday.

    Note

    The trigger time is in UTC+8. You can convert the cron expression based on your time zone.

    Note

    The system attempts to trigger the notification at the time specified by the cron expression. However, a delay may occur due to the report generation status. The cron expression limits the notification for the same template to a maximum of once per day.

    Note

    In addition to using MON for Monday, you can also use numbers. In the Quartz framework, 1 represents Sunday, 2 represents Monday, 3 represents Tuesday, 4 represents Wednesday, 5 represents Thursday, 6 represents Friday, and 7 represents Saturday.

    0 0 0 * * ?
    ReportScope

    array<object>

    No

    An array that specifies the report scope. It is used to select the range of rules to include in the audit report. The logical relationship between multiple ReportScope objects in the array is OR. This means the scopes are added together.

    Note

    For example, if the array contains two ReportScope objects, where the first specifies the rule In cr-1 and the second specifies the rule In cr-2, the report scope includes both cr-1 and cr-2.

    object

    No

    The report scope.

    Key

    string

    No

    The key of the report scope. Supported values:

    • AggregatorId

    • CompliancePackId

    • RuleId

    RuleId
    Value

    string

    No

    The value of the report scope. To specify multiple items of the same type, such as multiple rule IDs, separate them with commas (,).

    cr-1,cr-2
    MatchType

    string

    No

    The matching logic. Only In is supported.

    In

    Response elements

    Element

    Type

    Description

    Example

    object

    ReportTemplateId

    string

    The ID of the report template.

    crt-xxx
    RequestId

    string

    The request ID.

    A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7

    Examples

    Success response

    JSON format

    {
  "ReportTemplateId": "crt-xxx",
  "RequestId": "A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    503 ServiceUnavailable The request has failed due to a temporary failure of the server. The request has failed due to a temporary failure of the server.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.