GetConfigRuleComplianceByPack for querying rule compliance statistics in a compliance package - Cloud Config - Alibaba Cloud - Cloud Config

Queries the rule-level compliance statistics in a specified compliance package.

Operation description

This topic provides an example on how to query the compliance results compliance rules in the compliance package cp-541e626622af0087****. The response shows that the total number compliance rules is 1 and the number of non-compliant rules is 0.

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:GetConfigRuleComplianceByPack

get

*CompliancePack

acs:config:*:{#accountId}:compliancepack/{#CompliancePackId}

None

Request parameters

Parameter	Type	Required	Description	Example
CompliancePackId	string	Yes	The compliance package ID. For information about how to obtain the compliance package ID, see ListCompliancePacks.	cp-541e626622af0087****

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

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	6EC7AED1-172F-42AE-9C12-295BC2ADB751
ConfigRuleComplianceResult	object	The compliance results of rules in the compliance package.
CompliancePackId	string	The compliance package ID.	cp-541e626622af0087****
InsufficientDataCount	integer	The total number of rules whose evaluation results contain "Insufficient Data" when the rules in the compliance package evaluate resources.	1
ConfigRuleCompliances	array<object>	The list of rules and their compliance results in the compliance package.
	object	The rule compliance statistics information.
ComplianceType	string	The compliance evaluation result of the rule. Valid values: COMPLIANT: Compliant. NON_COMPLIANT: Non-compliant. NOT_APPLICABLE: Not applicable. INSUFFICIENT_DATA: Insufficient data.	COMPLIANT
ConfigRuleName	string	The name of the rule in the compliance package.	The bandwidth of the Elastic IP instance meets the minimum requirements.
ConfigRuleId	string	The ID of the rule in the compliance package.	cr-fdc8626622af00f9****
TotalCount	integer	The total number of rules in the compliance package.	1
NonCompliantCount	integer	The number of non-compliant compliance rules.	0
NotApplicableCount	integer	The total number of rules whose evaluation results contain "Not Applicable" when the rules in the compliance package evaluate resources.	1
IgnoredCount	integer	The total number of rules whose evaluation results contain "Ignored" when the rules in the compliance package evaluate resources.	1
CompliantCount	integer	The total number of rules whose evaluation results are all compliant when the rules in the compliance package evaluate resources.	0

Examples

Success response

JSON format

{
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751",
  "ConfigRuleComplianceResult": {
    "CompliancePackId": "cp-541e626622af0087****",
    "InsufficientDataCount": 1,
    "ConfigRuleCompliances": [
      {
        "ComplianceType": "COMPLIANT",
        "ConfigRuleName": "The bandwidth of the Elastic IP instance meets the minimum requirements.",
        "ConfigRuleId": "cr-fdc8626622af00f9****"
      }
    ],
    "TotalCount": 1,
    "NonCompliantCount": 0,
    "NotApplicableCount": 1,
    "IgnoredCount": 1,
    "CompliantCount": 0
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.CompliancePackId.Value	The specified CompliancePackId does not exist.	The specified compliance pack ID does not exist.
404	AccountNotExisted	Your account does not exist.
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.