GetConfigRulesReport - Cloud Config - Alibaba Cloud Documentation Center

Downloads the compliance evaluation report in the Excel format to your on-premises machine. This allows you to assign tasks and modify incompliant resource configurations.

Operation description

Note Before you call this operation, you must call the GenerateConfigRulesReport operation to generate the latest compliance evaluation report based on all existing rules. For more information, see GenerateConfigRulesReport .

This topic provides an example of how to query the compliance evaluation report that is generated based on all existing rules.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
config:GetConfigRulesReport	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ReportId	string	No	The ID of the compliance evaluation report.	crp-88176457e0d900c9****

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	6EC7AED1-172F-42AE-9C12-295BC2ADB751
ConfigRulesReport	object	The information about the compliance evaluation report.
ReportStatus	string	The status of the compliance evaluation report. Valid values: NONE: The compliance evaluation report is not generated. CREATING: The compliance evaluation report is being generated. COMPLETE: The compliance evaluation report is generated.	CREATING
ReportUrl	string	The URL that is used to download the compliance evaluation report.	https://cloud-config-compliance-report.oss-cn-shanghai.aliyuncs.com/ConfigRuleReports/100931896542**/rules/100931896542-rules-report-202106221125.zip?Expires=162433&OSSAccessKeyId=LTAIs86R8H59&Signature=yT8jn6ZQSX3dyCwVKL5EOJhGJ**
AccountId	long	The ID of the Alibaba Cloud account to which the rules belong.	100931896542****
ReportCreateTimestamp	long	The timestamp when the compliance evaluation report was generated. Unit: milliseconds.	1614687022000
ReportId	string	The ID of the compliance evaluation report.	crp-88176457e0d900c9****

Examples

Sample success responses

JSONformat

{
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751",
  "ConfigRulesReport": {
    "ReportStatus": "CREATING",
    "ReportUrl": "https://cloud-config-compliance-report.oss-cn-shanghai.aliyuncs.com/ConfigRuleReports/100931896542****/rules/100931896542****-rules-report-202106221125.zip?Expires=162433****&OSSAccessKeyId=LTAIs86R8H59****&Signature=yT8jn6ZQSX3dyCwVKL5EOJhGJ****",
    "AccountId": 0,
    "ReportCreateTimestamp": 1614687022000,
    "ReportId": "crp-88176457e0d900c9****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	AccountNotExisted	Your account does not exist.	The specified account does not exist.
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.

For a list of error codes, visit the Service error codes.