ListConfigRuleEvaluationResults - Cloud Config - Alibaba Cloud Documentation Center

Queries the compliance evaluation results of resources based on a rule.

Operation description

This topic provides an example on how to query the compliance evaluation result of resources based on a rule whose ID is cr-cac56457e0d900d3****. The returned result indicates that the i-hp3e4kvhzqn2s11t**** resource is evaluated as NON_COMPLIANT by using the rule. The resource is an Elastic Compute Service (ECS) instance.

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

Operation	Access level	Resource type	Condition key	Associated operation
config:ListConfigRuleEvaluationResults	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example

Parameter	Type	Required	Description	Example
ComplianceType	string	No	The compliance evaluation result of the resource. Valid values: COMPLIANT: The resource is evaluated as compliant. NON_COMPLIANT: The resource is evaluated as non-compliant. NOT_APPLICABLE: The rule does not apply to the resources. INSUFFICIENT_DATA: No data is available. IGNORED: The resource is ignored during compliance evaluation.	NON_COMPLIANT
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.	IWBjqMYSy0is7zSMGu16****
MaxResults	integer	No	The maximum number of entries to return in a request. Valid values: 1 to 100.	10
ConfigRuleId	string	No	The rule ID. You can call the ListConfigRules operation to obtain the rule ID.	cr-cac56457e0d900d3****
CompliancePackId	string	No	The ID of the compliance package. For more information about how to obtain the ID of a compliance package, see ListCompliancePacks .	cp-f1e3326622af00cb****
Regions	string	No	The ID of the region where the resources that you want to evaluate reside. Separate multiple region IDs with commas (,).	cn-shanghai
ResourceTypes	string	No	The type of the resources that you want to evaluate. Separate multiple resource types with commas (,).	ACS::ECS::Instane
ResourceGroupIds	string	No	The ID of the resource group to which the resources that you want to evaluate belong. Separate multiple resource group IDs with commas (,).	rg-aek2indxn3g****

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

Response parameters

Parameter	Type	Description	Example

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	2A4A33BD-8186-4D60-91B9-42174EED75B5
EvaluationResults	object	The compliance evaluation results returned.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	IWBjqMYSy0is7zSMGu16****
MaxResults	integer	The maximum number of entries returned per page.	10
EvaluationResultList	array<object>	The details of the compliance evaluation result.
EvaluationResult	object
RiskLevel	integer	The risk level of the resources that do not comply with the rule. Valid values: 1: high 2: medium 3: low	1
ComplianceType	string	The compliance evaluation result of the resource. 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. IGNORED: The resource is ignored during compliance evaluation.	NON_COMPLIANT
ResultRecordedTimestamp	long	The timestamp when the compliance evaluation result was recorded. Unit: milliseconds.	1622802307150
Annotation	string	The annotation to the resource that is evaluated as non-compliant. The following section describe the parameters that can be returned: `configuration`: the current resource configuration that is evaluated as non-compliant. `desiredValue`: the expected resource configuration that is evaluated as compliant. `operator`: the operator that compares the current configuration with the expected configuration of the resource. `property`: the JSON path of the current configuration in the resource property struct. `reason`: the reason why the resource is evaluated as non-compliant.	{\"configuration\":\"\",\"desiredValue\":\"\",\"operator\":\"IsNotStringEmpty\",\"property\":\"$.KeyPairName\",\"reason\":\"No property contains.\"}
ConfigRuleInvokedTimestamp	long	The timestamp when the rule was triggered for the compliance evaluation. Unit: milliseconds.	1622802307081
InvokingEventMessageType	string	The trigger type of the rule. Valid values: ConfigurationItemChangeNotification: The rule is triggered by configuration changes. ScheduledNotification: The rule is periodically triggered. Manual: The rule is manually triggered.	ConfigurationItemChangeNotification
EvaluationResultIdentifier	object	The identifying information about the compliance evaluation result.
OrderingTimestamp	long	The timestamp when the compliance evaluation was performed. Unit: milliseconds.	1622802307081
EvaluationResultQualifier	object	The information about the evaluated resource in the compliance evaluation result.
ResourceOwnerId	long	The ID of the Alibaba Cloud account to which the resource belongs.	120886317861****
ConfigRuleArn	string	The ARN of the rule.	acs:config::120886317861**:rule/cr-cac56457e0d900d3**
ResourceType	string	The type of the resource that is monitored by Cloud Config.	ACS::ECS::Instance
ConfigRuleName	string	The rule name.	test-rule-name
ResourceId	string	The resource ID.	i-hp3e4kvhzqn2s11t****
ConfigRuleId	string	The rule ID.	cr-cac56457e0d900d3****
ResourceName	string	The resource name.	iZuf6j91r34rnwawoox****
RegionId	string	The ID of the region in which your resources reside.	cn-hangzhou
CompliancePackId	string	The ID of the compliance package to which the rule belongs.	cp-bcc33457e0d900d5****
IgnoreDate	string	The date on which the system automatically re-evaluates the ignored incompliant resources. Note If the value of this parameter is left empty, the system does not automatically re-evaluate the ignored incompliant resources. You must manually re-evaluate the ignored incompliant resources.	2022-06-01
RemediationEnabled	boolean	Indicates whether the remediation template is enabled. Valid values: true: The remediation template is enabled. false: The remediation template is disabled.	false

Examples

Sample success responses

JSONformat

            
            
          
{
  "RequestId": "2A4A33BD-8186-4D60-91B9-42174EED75B5",
  "EvaluationResults": {
    "NextToken": "IWBjqMYSy0is7zSMGu16****",
    "MaxResults": 10,
    "EvaluationResultList": [
      {
        "RiskLevel": 1,
        "ComplianceType": "NON_COMPLIANT",
        "ResultRecordedTimestamp": 1622802307150,
        "Annotation": "{\\\"configuration\\\":\\\"\\\",\\\"desiredValue\\\":\\\"\\\",\\\"operator\\\":\\\"IsNotStringEmpty\\\",\\\"property\\\":\\\"$.KeyPairName\\\",\\\"reason\\\":\\\"No property contains.\\\"}",
        "ConfigRuleInvokedTimestamp": 1622802307081,
        "InvokingEventMessageType": "ConfigurationItemChangeNotification",
        "EvaluationResultIdentifier": {
          "OrderingTimestamp": 1622802307081,
          "EvaluationResultQualifier": {
            "ResourceOwnerId": 0,
            "ConfigRuleArn": "acs:config::120886317861****:rule/cr-cac56457e0d900d3****",
            "ResourceType": "ACS::ECS::Instance",
            "ConfigRuleName": "test-rule-name",
            "ResourceId": "i-hp3e4kvhzqn2s11t****",
            "ConfigRuleId": "cr-cac56457e0d900d3****",
            "ResourceName": "iZuf6j91r34rnwawoox****",
            "RegionId": "cn-hangzhou",
            "CompliancePackId": "cp-bcc33457e0d900d5****",
            "IgnoreDate": "2022-06-01"
          }
        },
        "RemediationEnabled": false
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
404	CloudConfigServiceRoleNotExisted	The CloudConfigServiceRole 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.

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