GetReportTemplate - Cloud Config - Alibaba Cloud Documentation Center

Retrieve details of 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
ReportTemplateId	string	Yes	ID of the report template.	crt-xxx

Response elements

Element	Type	Description	Example
	object
ReportTemplate	object	Report template.
ReportTemplateId	string	ID of the report template.	crt-xxx
ReportTemplateName	string	Name of the report template.	test-name
SubscriptionFrequency	string	Subscription frequency for the report. If this field is not empty, it contains a Quartz-formatted cron expression that triggers notifications. The format is: seconds minutes hours day-of-month month day-of-week. Common examples include the following: Run daily at 00:00: 0 0 0 * * ? Run every Monday at 15:30: 0 30 15 ? * MON Run on the first day of each month at 02:00: 0 0 2 1 * ? Where: "" means any value. "?" means no specific value for the day-of-month or day-of-week field. MON means Monday. Note* Trigger times are in UTC+8. Adjust your cron expression based on your time zone. Note The system tries to trigger notifications as close as possible to the scheduled time. Delays may occur due to report generation status. A single template can trigger at most one notification per day. Note In Quartz, days of the week are numbered: 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday.	0 0 0 * * ?
ReportTemplateDescription	string	Description of the report template.	test-description
ReportGranularity	string	Aggregation granularity of the report.	AllInOne
ReportFileFormats	string	Report file format.	excel
ReportLanguage	string	Report language. Valid values: zh-CN and en-US. Default is en-US if empty.	en-US
ReportScope	array<object>	Array of report scopes. Each scope defines a set of rules included in the audit report. Scopes use OR logic. That is, rules from all scopes are combined. Note If the array has two items, and the first specifies RuleId cr-1 while the second specifies RuleId cr-2, then the report covers both cr-1 and cr-2.
	object	Report scope.
Key	string	Key for the report scope. Supported keys: AggregatorId CompliancePackId RuleId	RuleId
Value	string	Value for the report scope. For multiple values of the same type, such as multiple rule IDs, separate them with commas.	cr-1,cr-2
MatchType	string	Matching logic. Only In is supported.	In
RequestId	string	Request ID.	A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7

Examples

Success response

JSON format

{
  "ReportTemplate": {
    "ReportTemplateId": "crt-xxx",
    "ReportTemplateName": "test-name",
    "SubscriptionFrequency": "0 0 0 * * ?",
    "ReportTemplateDescription": "test-description",
    "ReportGranularity": "AllInOne",
    "ReportFileFormats": "excel",
    "ReportLanguage": "en-US",
    "ReportScope": [
      {
        "Key": "RuleId",
        "Value": "cr-1,cr-2",
        "MatchType": "In"
      }
    ]
  },
  "RequestId": "A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ReportTemplateNotExist	Report template does not exist or invalid.	Report template does not exist, please check the input ReportTemplateId
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.