GetResourceComplianceByConfigRule - Cloud Config - Alibaba Cloud Documentation Center

Queries the compliance summary based on the compliance evaluation result of a rule.

Operation description

In this topic, the cr-d369626622af008e**** rule is used as an example. The return result shows that a total of 10 resources are evaluated by the rule and five of them are evaluated as 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:
- 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:GetResourceComplianceByConfigRule	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ComplianceType	string	No	The compliance evaluation result. Valid values: COMPLIANT: The resources are evaluated as compliant. NON_COMPLIANT: The resources are evaluated as non-compliant. NOT_APPLICABLE: The rule does not apply to the resources. INSUFFICIENT_DATA: No data is available.	COMPLIANT
ConfigRuleId	string	Yes	The rule ID.	cr-d369626622af008e****

For information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
ComplianceResult	object	The compliance result.
TotalCount	long	The total number of evaluated resources.	10
Compliances	array<object>	The compliance evaluation results based on compliance types.
Compliances	object	N/A.
ComplianceType	string	The compliance evaluation results of the resources. Valid values: COMPLIANT: The resource was evaluated as compliant. NON_COMPLIANT: The resource was evaluated as incompliant. NOT_APPLICABLE: The rule did not apply to your resources. INSUFFICIENT_DATA: No resource data was available.	COMPLIANT
Count	integer	The number of resources that have compliance evaluation results. For example, if the value of the `ComplianceType` parameter is `COMPLIANT`, this parameter value indicates the number of compliant resources.	5
RequestId	string	The request ID.	23306AB1-34E0-468F-BD7B-68D8AEAB753d

Examples

Sample success responses

JSONformat

{
  "ComplianceResult": {
    "TotalCount": 10,
    "Compliances": [
      {
        "ComplianceType": "COMPLIANT",
        "Count": 5
      }
    ]
  },
  "RequestId": "23306AB1-34E0-468F-BD7B-68D8AEAB753d"
}

Error codes

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

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