CreateReportTemplate - Cloud Config - Alibaba Cloud Documentation Center

Creates a compliance report template for the current UID.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:CreateReportTemplate

create

*ReportTemplate

acs:config::{#accountId}:reporttemplate/*

None

Request parameters

Parameter	Type	Required	Description	Example
ReportTemplateName	string	Yes	The name of the report template.	test-report-name
ReportTemplateDescription	string	No	The description of the report template.	test-report-description
ReportGranularity	string	No	The aggregation granularity of the report. From the management account perspective, the following values are supported: AllInOne (aggregates all accounts into a single report), GroupByAggregator (aggregates by account group and generates a compressed file), and GroupByAccount (generates a separate report for each account and generates a compressed file). From the member accounts perspective, only GroupByAccount is supported. This parameter is effectively required. If omitted, the server returns Invalid.ReportGranularity.Value (400) and does not use a default value. Valid values: AllInOne : Aggregates all accounts within the template scope into a single report. GroupByAggregator : Aggregates reports by account group and generates a compressed file. GroupByAccount : Generates a separate report for each account (default) and generates a compressed file.	GroupByAccount
ReportFileFormats	string	No	The format of the report. Currently, only excel is supported.	excel
ReportLanguage	string	No	The language of the report. Valid values: zh-CN and en-US. Default value: en-US.	zh-CN
SubscriptionFrequency	string	No	The subscription frequency of the report. If this field is not empty, it specifies a Quartz-format cron expression that triggers subscription notifications. The format is: second minute hour day month week. The following are common cron expression examples: Execute at 00:00 every day: 0 0 0 * * ? Execute at 15:30 every Monday: 0 30 15 ? * MON Execute at 02:00 on the 1st of every month: 0 0 2 1 * ? Where: "" indicates any value. ? is used in the day and week fields to indicate that no specific value is specified. MON indicates Monday. Note* The trigger time is in UTC+8. Convert the cron expression settings based on your time zone. Note The system attempts to trigger notifications based on the cron expression time, but delays may occur due to report generation status. The cron expression limits notifications to at most once per day for the same template. Note In addition to using MON to represent Monday, you can also use numbers. Note that 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 9 * * ?
ReportScope	array<object>	No	The report scope array that specifies the rule scope included in the audit report. The ReportScope items in the array follow OR logic, which means they are additive. Note For example, if the array size is 2, the first ReportScope specifies rule In cr-1, and the second ReportScope specifies rule In cr-2, the rule scope of this report includes both cr-1 and cr-2.
	object	No	The report scope.
Key	string	No	The key of the report scope. Valid values: AggregatorId CompliancePackId RuleId Valid values: CompliancePackId : compliance pack ID. RuleId : rule ID. AggregatorId : account group ID.	RuleId
Value	string	No	The value of the report scope. Multiple items of the same type, such as multiple rule IDs, can be separated by commas (,).	cr-1,cr-2
MatchType	string	No	The matching logic. Currently, only In is supported.	In

Response elements

Element	Type	Description	Example
	object	The response parameters.
ReportTemplateId	string	The ID of the report template.	crt-xxx
RequestId	string	The request ID.	A7A0FFF8-0B44-40C6-8BBF-3A185EFDFXXX

Examples

Success response

JSON format

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

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.