ListConfigRuleEvaluationResults - Cloud Config - Alibaba Cloud Documentation Center

Queries the evaluation results of resources based on rules.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ComplianceType	string	No	Compliance evaluation result. Valid values: COMPLIANT: The resource is compliant. NON_COMPLIANT: The resource is non-compliant. NOT_APPLICABLE: The rule is not applicable to the resource. INSUFFICIENT_DATA: No data is available. IGNORED: The evaluation result is ignored.	NON_COMPLIANT
NextToken	string	No	When the response to your request is truncated, you can use `NextToken` to initiate another request to obtain the content after the truncation point.	IWBjqMYSy0is7zSMGu16****
MaxResults	integer	No	The maximum number of results to return for a single request. Valid values: 1 to 100.	10
ConfigRuleId	string	No	The rule ID. For more information about how to obtain the rule ID, see ListConfigRules.	cr-cac56457e0d900d3****
CompliancePackId	string	No	The compliance package ID. For more information about how to obtain the compliance package ID, see ListCompliancePacks.	cp-f1e3326622af00cb****
Regions	string	No	The regions to which the evaluated resources belong. Separate multiple regions with commas (,).	cn-shanghai
ResourceTypes	string	No	The resource types of the evaluated resources. Separate multiple resource types with commas (,).	ACS::ECS::Instane
ResourceGroupIds	string	No	The resource group IDs to which the evaluated resources belong. Separate multiple resource group IDs with commas (,).	rg-aek2indxn3g****

For more information, see Common parameters.

Response elements

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	2A4A33BD-8186-4D60-91B9-42174EED75B5
EvaluationResults	object	The rule evaluation results.
NextToken	string	The token used to query the next page.	IWBjqMYSy0is7zSMGu16****
MaxResults	integer	The maximum number of records on each page.	10
EvaluationResultList	array<object>	The list of rule evaluation results.
	object	None.
RiskLevel	integer	The risk level of the rule. Valid values: 1: High risk. 2: Medium risk. 3: Low risk.	1
ComplianceType	string	The compliance evaluation result. Valid values: COMPLIANT: The resource is compliant. NON_COMPLIANT: The resource is non-compliant. NOT_APPLICABLE: The rule is not applicable to the resource. INSUFFICIENT_DATA: No data is available. IGNORED: The evaluation result is ignored.	NON_COMPLIANT
ResultRecordedTimestamp	integer	The timestamp when the resource evaluation result was generated. Unit: milliseconds.	1622802307150
Annotation	string	The supplementary information about the non-compliant resource. This may include the following information: `configuration`: The current actual configuration of the resource, which is the non-compliant configuration. `desiredValue`: The expected configuration of the resource, which is the compliant configuration. `operator`: The comparison operator between the current configuration and the expected configuration. `property`: The JSON path of the current configuration in the resource property struct. `reason`: The reason why the resource is non-compliant.	{\"configuration\":\"\",\"desiredValue\":\"\",\"operator\":\"IsNotStringEmpty\",\"property\":\"$.KeyPairName\",\"reason\":\"No property contains.\"}
ConfigRuleInvokedTimestamp	integer	The timestamp when the rule was triggered to perform the evaluation. Unit: milliseconds.	1622802307081
InvokingEventMessageType	string	The rule trigger mechanism. Valid values: ConfigurationItemChangeNotification: The rule is triggered upon configuration changes. ScheduledNotification: The rule is triggered on a schedule. Manual: The rule is triggered manually.	ConfigurationItemChangeNotification
EvaluationResultIdentifier	object	The identifier of the rule evaluation result.
OrderingTimestamp	integer	The timestamp displayed on the timeline. Unit: milliseconds.	1622802307081
EvaluationResultQualifier	object	The resource information in the rule evaluation result.
ResourceOwnerId	integer	The ID of the Alibaba Cloud account to which the resource belongs.	120886317861****
ConfigRuleArn	string	The Alibaba Cloud Resource Name (ARN) of the rule.	acs:config::120886317861**:rule/cr-cac56457e0d900d3**
ResourceType	string	The resource type.	ACS::ECS::Instance
ConfigRuleName	string	The name of the rule.	test-rule-name
ResourceGroupId	string
ConfigRuleId	string	The rule ID.	cr-cac56457e0d900d3****
ResourceName	string	The name of the resource.	iZuf6j91r34rnwawoox****
RegionId	string	The ID of the region to which the resource belongs.	cn-hangzhou
CompliancePackId	string	The ID of the compliance package to which the rule belongs.	cp-bcc33457e0d900d5****
IgnoreDate	string	The date when the ignored evaluation result will be automatically restored. Note If this parameter is empty, automatic restoration is not available and you need to manually restore the evaluation result.	2022-06-01
ResourceId	string	The resource ID.	i-hp3e4kvhzqn2s11t****
RemediationEnabled	boolean	Indicates whether remediation settings are enabled. Valid values: true: Remediation settings are enabled. false: Remediation settings are not enabled.	false
EvaluationId	string	The unique ID of the evaluation result.	00000089-4e0d-58b5-a96a-8e54112110f3
LastNonCompliantRecordTimestamp	integer	The start time of the most recent non-compliance.	1744696665000

Examples

Success response

JSON format

{
  "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",
            "ResourceGroupId": "",
            "ConfigRuleId": "cr-cac56457e0d900d3****",
            "ResourceName": "iZuf6j91r34rnwawoox****",
            "RegionId": "cn-hangzhou",
            "CompliancePackId": "cp-bcc33457e0d900d5****",
            "IgnoreDate": "2022-06-01",
            "ResourceId": "i-hp3e4kvhzqn2s11t****"
          }
        },
        "RemediationEnabled": false,
        "EvaluationId": "00000089-4e0d-58b5-a96a-8e54112110f3",
        "LastNonCompliantRecordTimestamp": 1744696665000
      }
    ]
  }
}

Error codes

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.