ListReportTemplates - Cloud Config - Alibaba Cloud Documentation Center

Queries the details of compliance report templates in batches.

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
NextToken	string	No	If the response is truncated, use NextToken to send another request and get results after the truncation point.	IWBjqMYSy0is7zSMGu16****
MaxResults	integer	No	The number of entries to return per page. Default value: 20.	20
Keyword	string	No	The keyword for your search. You can perform a fuzzy query on template ID, template name, or template description.	test-description

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	8195B664-9565-4685-89AC-8B5F04B44B92
TotalCount	integer	The total number of templates.	7
MaxResults	integer	The maximum number of entries to return per page. Valid values: 1 to 50. Default value: 20.	20
NextToken	string	If the response is truncated, use NextToken to send another request and get results after the truncation point.	aVCjqNaSy0Ps7zSMGu25****
ReportTemplateList	array<object>	The list of report templates.
	array<object>
ReportTemplateId	string	The ID of the report template.	crt-xxx
ReportTemplateName	string	The name of the report template.	test-name
ReportTemplateDescription	string	The description of the report template.	test-description
ReportGranularity	string	The aggregation granularity of the report. From the management account perspective, the following options are supported: AllInOne: Aggregate all accounts in the template scope into one report. GroupByAggregator: Generate reports by aggregator group. Output as one compressed file. GroupByAccount: Generate separate reports for each account (default). Output as one compressed file. Member accounts support only GroupByAccount.	AllInOne
ReportFileFormats	string	The format of the report. Only Excel is supported.	excel
ReportLanguage	string	The language of the report. Valid values: zh-CN and en-US. Default value: en-US.	en-US
SubscriptionFrequency	string	The subscription frequency of the report. If this parameter is specified, it must be a Quartz-formatted cron expression. The format is: second minute hour day month weekday. Common examples: 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 day or weekday. "MON" means Monday. Note* Times are in UTC+8. Adjust your cron expression based on your local time zone. Note The system tries to run reports at the scheduled time, but delays may occur due to report generation. Each template can trigger at most one notification per day. Note In Quartz, weekdays are numbered starting from Sunday: 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday.	0 0 13 * * ?
ReportScope	array<object>	An array that defines which rules appear in the audit report. Each ReportScope object uses OR logic (additive logic). Note For example, if the array has two items — the first specifies RuleId cr-1 and the second specifies RuleId cr-2 — then the report covers both cr-1 and cr-2.
	object	A report scope definition.
Key	string	The key for the report scope. Supported values: AggregatorId CompliancePackId RuleId	RuleId
Value	string	The 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	The matching logic. Only In is supported.	In

Examples

Success response

JSON format

{
  "RequestId": "8195B664-9565-4685-89AC-8B5F04B44B92",
  "TotalCount": 7,
  "MaxResults": 20,
  "NextToken": "aVCjqNaSy0Ps7zSMGu25****",
  "ReportTemplateList": [
    {
      "ReportTemplateId": "crt-xxx",
      "ReportTemplateName": "test-name",
      "ReportTemplateDescription": "test-description",
      "ReportGranularity": "AllInOne",
      "ReportFileFormats": "excel",
      "ReportLanguage": "en-US",
      "SubscriptionFrequency": "0 0 13 * * ?",
      "ReportScope": [
        {
          "Key": "RuleId",
          "Value": "cr-1,cr-2",
          "MatchType": "In"
        }
      ]
    }
  ]
}

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.