All Products
Search
Document Center

Cloud Config:GetConfigRuleSummaryByRiskLevel

Last Updated:Jun 24, 2024

Queries the compliance summary based on the risk level of a rule.

Operation description

This topic provides an example of how to query the summary of compliance evaluation results by rule risk level. The return result shows four rules that are specified with the high risk level. One of them detects non-compliant resources, and the resources evaluated by the remaining three are all 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
The current API does not require request parameters

For information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

A3CED98C-DE65-46AC-B2D2-04A4A9AB5B36
ConfigRuleSummariesobject []

The summary of compliance evaluation results by rule risk level.

RiskLevelinteger

The risk level of the resources that are not compliant with the rules. Valid values:

  • 1: high risk level.
  • 2: medium risk level.
  • 3: low risk level.
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": "A3CED98C-DE65-46AC-B2D2-04A4A9AB5B36",
  "ConfigRuleSummaries": [
    {
      "RiskLevel": 1,
      "CompliantCount": 3,
      "NonCompliantCount": 1
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
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.