Queries the compliance evaluation report that is generated based on all rules in an account group.

Note Before you call this operation, you must call the GenerateAggregateConfigRulesReport operation to generate the latest compliance evaluation report based on all rules in an account group as required. For more information, see GenerateAggregateConfigRulesReport.

The sample request in this topic shows you how to query the compliance evaluation report that is generated based on all rules in the ca-f632626622af0079**** account group.

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 GetAggregateConfigRulesReport

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

AggregatorId String Yes ca-f632626622af0079****

The ID of the account group.

For more information about how to query the ID of an account group, see ListAggregators.

ReportId String No crp-88176457e0d900c9****

The ID of the compliance evaluation report.

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

Response parameters

Parameter Type Example Description
RequestId String F0BCC7B2-D0E4-49B0-95D2-6689CFB08D31

The ID of the request.

ConfigRulesReport Object

The information about the compliance evaluation report.

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.

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.
AccountId Long 100931896542****

The ID of the management account to which the rules belong.

AggregatorId String ca-f632626622af0079****

The ID of the account group.

ReportCreateTimestamp Long 1624332329593

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

ReportId String crp-88176457e0d900c9****

The ID of the compliance evaluation report.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetAggregateConfigRulesReport
&AggregatorId=ca-f632626622af0079****
&<Common request parameters>

Sample success responses

XML format 

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

<GetAggregateConfigRulesReportResponse>
    <RequestId>F0BCC7B2-D0E4-49B0-95D2-6689CFB08D31</RequestId>
    <ConfigRulesReport>
        <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>
        <ReportStatus>CREATING</ReportStatus>
        <AggregatorId>ca-f632626622af0079****</AggregatorId>
        <ReportCreateTimestamp>1624332329593</ReportCreateTimestamp>
        <ReportId>crp-88176457e0d900c9****</ReportId>
    </ConfigRulesReport>
</GetAggregateConfigRulesReportResponse>

JSON format 

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

{
  "RequestId" : "F0BCC7B2-D0E4-49B0-95D2-6689CFB08D31",
  "ConfigRulesReport" : {
    "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****",
    "ReportStatus" : "CREATING",
    "AggregatorId" : "ca-f632626622af0079****",
    "ReportCreateTimestamp" : 1624332329593,
    "ReportId" : "crp-88176457e0d900c9****"
  }
}

Error codes

HTTP status code Error code Error message Description
400 Invalid.AggregatorId.Value The specified AggregatorId is invalid. The error message returned because the specified account group ID does not exist or you are not authorized to use the account group.
404 AccountNotExisted Your account does not exist. The error message returned because the specified 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.