Queries the compliance evaluation report that is generated based on all existing rules.

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetConfigRulesReport

The operation that you want to perform. Set the value to GetConfigRulesReport.

For information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String 6EC7AED1-172F-42AE-9C12-295BC2ADB751

The ID of the request.

ConfigRulesReport Object

The information about the compliance evaluation report.

ReportStatus String CREATING

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.
ReportUrl String https://cloud-config-compliance-report.oss-cn-shanghai.aliyuncs.com/ConfigRuleReports/100931896542****/rules/100931896542****-rules-report-202106221125.zip?Expires=162433****&OSSAccessKeyId=LTAIs86R8H59****&Signature=yT8jn6ZQSX3dyCwVKL5EOJhGJ****

The URL that is used to download the compliance evaluation report.

AccountId Long 100931896542****

The ID of the Alibaba Cloud account to which the rules belong.

ReportCreateTimestamp Long 1614687022000

The timestamp when the compliance evaluation report was generated. Unit: milliseconds.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetConfigRulesReport
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetConfigRulesReportResponse>
	<RequestId>6EC7AED1-172F-42AE-9C12-295BC2ADB751</RequestId>
	<ConfigRulesReport>
		<AccountId>100931896542****</AccountId>
		<ReportUrl>https://cloud-config-compliance-report.oss-cn-shanghai.aliyuncs.com/ConfigRuleReports/100931896542****/rules/100931896542****-rules-report-202106221125.zip?Expires=162433****&amp;OSSAccessKeyId=LTAIs86R8H59****&amp;Signature=yT8jn6ZQSX3dyCwVKL5EOJhGJ****</ReportUrl>
		<ReportCreateTimestamp>1614687022000</ReportCreateTimestamp>
		<ReportStatus>CREATING</ReportStatus>
	</ConfigRulesReport>
</GetConfigRulesReportResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6EC7AED1-172F-42AE-9C12-295BC2ADB751",
  "ConfigRulesReport" : {
    "AccountId" : "100931896542****",
    "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****",
    "ReportCreateTimestamp" : 1614687022000,
    "ReportStatus" : "CREATING"
  }
}

Error codes

HTTP status code Error code Error message Description
404 AccountNotExisted Your account does not exist. The error message returned because your account does not exist.
503 ServiceUnavailable The request has failed due to a temporary failure of the server. The error message returned because the service is unavailable.

For a list of error codes, visit the API Error Center.