All Products
Search
Document Center

Cloud Config:GetAggregateConfigRuleSummaryByRiskLevel

Last Updated:Mar 01, 2024

Queries the summary of compliance evaluation results by rule risk level in an account group.

Operation description

This topic provides an example on how to query the summary of compliance evaluation results by rule risk level in the ca-3a58626622af0005**** account group. The returned result shows four rules that are specified with the high risk level. One of the rules detects non-compliant resources, and the resources evaluated by the remaining three are compliant.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

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-3a58626622af0005****

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

A3CDD98C-DE65-46AC-B2D2-04A4A9AB5B73
ConfigRuleSummariesobject []

The summary of compliance evaluation results by rule risk level.

RiskLevelinteger

The risk level of the resources that do not comply with the rule. Valid values:

  • 1: high
  • 2: medium
  • 3: low
1
CompliantCountinteger

The number of rules against which specific resources are evaluated as compliant.

3
NonCompliantCountinteger

The number of rules against which specific resources are evaluated as non-compliant.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "A3CDD98C-DE65-46AC-B2D2-04A4A9AB5B73",
  "ConfigRuleSummaries": [
    {
      "RiskLevel": 1,
      "CompliantCount": 3,
      "NonCompliantCount": 1
    }
  ]
}

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.
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.