Queries compliance evaluation results based on the rules in a compliance package in an account group.
Operation description
This topic provides an example on how to query the compliance evaluation results based on the cr-d369626622af008e**** rule in the ca-a4e5626622af0079**** account group. The returned result shows that a total of 10 resources are evaluated by the rule and five of them are evaluated as compliant.
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:GetAggregateResourceComplianceByConfigRule | Read |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ComplianceType | string | No | The compliance evaluation result of the resources. Valid values:
| COMPLIANT |
| ConfigRuleId | string | Yes | The ID of the rule. For more information about how to obtain the ID of a rule, see ListAggregateConfigRules . | cr-d369626622af008e**** |
| 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-a4e5626622af0079**** |
| ResourceAccountId | long | No | The ID of the Alibaba Cloud account to which the resources in the account group belong. Note
You can use either the ResourceAccountId or ResourceOwnerId parameter. We recommend that you use the ResourceAccountId parameter.
| 100931896542**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"ComplianceResult": {
"TotalCount": 5,
"Compliances": [
{
"ComplianceType": "COMPLIANT",
"Count": 3
}
]
},
"RequestId": "23306AB1-34E0-468F-BD7B-68D8AEAB754C"
}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. |
| 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-04-12 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||
|