All Products
Search
Document Center

Cloud Config:GetConfigRuleSummaryByRiskLevel

Last Updated:Mar 08, 2023

Queries the summary of compliance evaluation results by rule risk level.

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.

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.
OperationAccess levelResource typeCondition keyAssociation operation
config:GetConfigRuleSummaryByRiskLevelRead
  • Config
    acs:config:*:{#accountId}:*
    none
none

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
ConfigRuleSummariesarray

The summary of compliance evaluation results by rule risk level.

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