GetConfigRuleSummaryByRiskLevel - Cloud Config - Alibaba Cloud Documentation Center

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:GetConfigRuleSummaryByRiskLevel	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

For information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	A3CED98C-DE65-46AC-B2D2-04A4A9AB5B36
ConfigRuleSummaries	array<object>	The summary of compliance evaluation results by rule risk level.
Data	object
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
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

Examples

Sample success responses

JSONformat

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

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.

For a list of error codes, visit the Service error codes.