ListAggregateConfigRuleEvaluationStatistics - Cloud Config

Queries the statistics of compliance evaluation results of an account group.

Operation description

This topic provides an example on how to query the statistics of compliance evaluation results of an account group whose ID is ca-edd3626622af00b3****.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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	Associated operation
config:ListAggregateConfigRuleEvaluationStatistics	List	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
AggregatorId	string	Yes	The ID of the account group. For more information about how to obtain the ID of an account group, see ListAggregators .	ca-edd3626622af00b3****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	9EFA436B-FC6F-513B-9DB8-C96E6CEBE5E0
EvaluationResults	object []	The statistics of compliance evaluation results.
AggregatorId	string	The ID of the account group.	ca-edd3626622af00b3****
NonCompliantResourceCnt	integer	The number of resources that are evaluated as non-compliant.	25
TotalResourceCnt	integer	The total number of resources.	153
NonCompliantRuleCnt	integer	The number of rules based on which resources are evaluated as non-compliant.	3
TotalRuleCnt	integer	The total number of rules.	10
StatisticDate	string	The date on which the statistics are obtained.	2023-06-27

Examples

Sample success responses

JSONformat

{
  "RequestId": "9EFA436B-FC6F-513B-9DB8-C96E6CEBE5E0",
  "EvaluationResults": [
    {
      "AggregatorId": "ca-edd3626622af00b3****",
      "NonCompliantResourceCnt": 25,
      "TotalResourceCnt": 153,
      "NonCompliantRuleCnt": 3,
      "TotalRuleCnt": 10,
      "StatisticDate": "2023-06-27"
    }
  ]
}

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	Invalid.ResourceOwnerId.Value	The specified ResourceOwnerId is invalid.	The specified ResourceOwnerId is invalid.
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.