GetAggregateResourceComplianceByConfigRule - Cloud Config

Queries the compliance evaluation results based on a rule in an account group.

Operation Description

The sample request in this topic shows you how to query the compliance evaluation results based on the cr-d369626622af008e**** rule in the ca-a4e5626622af0079**** account group. The return result shows that a total of 10 resources are evaluated by the rule and five of them are evaluated as compliant.

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.

Operation	Access level	Resource type	Condition key	Association operation
config:GetAggregateResourceComplianceByConfigRule	Read	Config acs:config::{#accountId}:	none	none

Request parameters

Parameter	Type	Required	Description	Example
ComplianceType	string	No	The compliance evaluation result of the resources. Valid values: COMPLIANT: The resources are evaluated as compliant. NON_COMPLIANT: The resources are evaluated as non-compliant. NOT_APPLICABLE: The rule does not apply to your resources. INSUFFICIENT_DATA: No resource data is available.	COMPLIANT
ConfigRuleId	string	Yes	The ID of the rule. For more information about how to query the ID of a rule, see ListAggregateConfigRules.	cr-d369626622af008e****
AggregatorId	string	Yes	The ID of the account group. For more information about how to query the ID of an account group, see ListAggregators.	ca-a4e5626622af0079****

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

Response parameters

Parameter	Type	Description	Example
	object
ComplianceResult	object	The return result of the request.
TotalCount	long	The total number of evaluated resources.	10
Compliances	array	The compliance evaluation results returned.
	object
ComplianceType	string	The compliance evaluation result of the resources. Valid values: COMPLIANT: The resources are evaluated as compliant. NON_COMPLIANT: The resources are evaluated as non-compliant. NOT_APPLICABLE: The rule does not apply to your resources. INSUFFICIENT_DATA: No resource data is available.	COMPLIANT
Count	integer	The number of resources that have the compliance evaluation result. For example, if the value of the `ComplianceType` parameter is `COMPLIANT`, this parameter value indicates the number of compliant resources.	5
RequestId	string	The ID of the request.	23306AB1-34E0-468F-BD7B-68D8AEAB754C

Examples

Sample success responses

JSONformat

{
  "ComplianceResult": {
    "TotalCount": 10,
    "Compliances": [
      {
        "ComplianceType": "COMPLIANT",
        "Count": 5
      }
    ]
  },
  "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.