Generates a compliance evaluation report for the rules in a specified account group.
Operation description
The topic provides an example on how to generate a compliance evaluation report based on all rules in the ca-f632626622af0079**** account group.
Debugging
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 Resourcesis 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:GenerateAggregateConfigRulesReport | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The | 1594295238-f9361358-5843-4294-8d30-b5183fac**** |
| AggregatorId | string | Yes | The ID of the account group. For more information about how to obtain the ID of the account group, see ListAggregators . | ca-f632626622af0079**** |
| ConfigRuleIds | string | No | The rule ID. Separate multiple rule IDs with commas (,). For more information about how to obtain the ID of a rule, see ListAggregateConfigRules . | cr-25d86457e0d900b5**** |
For more information about common request parameters, see Common parameters.
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751",
"AggregatorId": "ca-f632626622af0079****",
"ReportId": "crp-88176457e0d900c9****"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Invalid.AggregatorId.Value | The specified AggregatorId is invalid. | The specified aggregator ID does not exist or you are not authorized to use the aggregator. |
| 400 | ConfigRuleReportCreating | The config rule report is being created. | The config rule report is being created. |
| 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.
Change history
| Change time | Summary of changes | Operation | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-06-13 | API Description Update. The Error code has changed | see changesets | ||||||||||
|