All Products
Search
Document Center

Cloud Config:GetAggregateConfigRulesReport

Last Updated:Mar 01, 2024

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

Operation description

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. For more information, see GenerateAggregateConfigRulesReport .

This topic provides an example on 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
config:GetAggregateConfigRulesReportRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AggregatorIdstringYes

The ID of the account group.

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

ca-f632626622af0079****
ReportIdstringNo

The ID of the compliance evaluation report.

crp-88176457e0d900c9****

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

Response parameters

ParameterTypeDescriptionExample
object

N/A.

RequestIdstring

The request ID.

F0BCC7B2-D0E4-49B0-95D2-6689CFB08D31
ConfigRulesReportobject

The information about the compliance evaluation report.

ReportUrlstring

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****
ReportStatusstring

The status of the compliance evaluation report. Valid values:

  • NONE: The compliance evaluation report was not generated.
  • CREATING: The compliance evaluation report was being generated.
  • COMPLETE: The compliance evaluation report was generated.
CREATING
AccountIdlong

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

100931896542****
AggregatorIdstring

The ID of the account group.

ca-f632626622af0079****
ReportCreateTimestamplong

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

1624332329593
ReportIdstring

The ID of the compliance evaluation report.

crp-88176457e0d900c9****

Examples

Sample success responses

JSONformat

{
  "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",
    "AccountId": 0,
    "AggregatorId": "ca-f632626622af0079****",
    "ReportCreateTimestamp": 1624332329593,
    "ReportId": "crp-88176457e0d900c9****"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe 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.