GetConfigRuleComplianceByPack - Cloud Config - Alibaba Cloud Documentation Center

Queries compliance evaluation results based on the rules in a compliance package.

Operation description

In this topic, the cp-541e626622af0087**** compliance package is used as an example. The return result shows a total of one rule against which specific resources are evaluated as compliant.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

Operation	Access level	Resource type	Condition key	Associated operation
config:GetConfigRuleComplianceByPack	Read	All Resources *	none	none

Request parameters

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

For information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	6EC7AED1-172F-42AE-9C12-295BC2ADB751
ConfigRuleComplianceResult	object	The information about the compliance evaluation results returned.
CompliancePackId	string	The ID of the compliance package.	cp-541e626622af0087****
NonCompliantCount	integer	The number of rules against which specific resources are evaluated as non-compliant.	0
ConfigRuleCompliances	object []	The rule enabled in the compliance package and the compliance evaluation result returned by the rule.
ComplianceType	string	The compliance evaluation result. Valid values: COMPLIANT: The relevant resources are evaluated as compliant. NON_COMPLIANT: The relevant resources are evaluated as non-compliant. NOT_APPLICABLE: The rule does not apply to your resources. INSUFFICIENT_DATA: No resource data is available.	COMPLIANT
ConfigRuleName	string	The name of the rule enabled in the compliance package.	test-rule-name
ConfigRuleId	string	The ID of the rule enabled in the compliance package.	cr-fdc8626622af00f9****
TotalCount	integer	The total number of rules enabled in the compliance package.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751",
  "ConfigRuleComplianceResult": {
    "CompliancePackId": "cp-541e626622af0087****",
    "NonCompliantCount": 0,
    "ConfigRuleCompliances": [
      {
        "ComplianceType": "COMPLIANT",
        "ConfigRuleName": "test-rule-name",
        "ConfigRuleId": "cr-fdc8626622af00f9****"
      }
    ],
    "TotalCount": 1
  }
}

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.	The specified 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.

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