GetConfigRuleSummaryByRiskLevel - Cloud Config - Alibaba Cloud Documentation Center

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:GetConfigRuleSummaryByRiskLevel

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

For information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
ConfigRuleSummaries	array<object>	The summary of compliance evaluation results by rule risk level.
	object
CompliantCount	integer	The number of rules against which specific resources are evaluated as compliant.	3
NonCompliantCount	integer	The number of rules against which specific resources are evaluated as non-compliant.	1
RiskLevel	integer	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
RequestId	string	The ID of the request.	A3CED98C-DE65-46AC-B2D2-04A4A9AB5B36

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.