ListAggregateResourceEvaluationResults - Cloud Config - Alibaba Cloud Documentation Center

Queries the rule evaluation results for resources in a specified account group.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	No	The resource type. For more information about how to obtain the resource type, see ListAggregateDiscoveredResources.	ACS::RAM::User
ResourceId	string	No	The resource ID. For more information about how to obtain the resource ID, see ListAggregateDiscoveredResources.	23642660635396****
RiskLevel	integer	No	The risk level of the compliance package. Valid values: 1: high 2: medium 3: low	1
SortBy	string	No	The sorting method. By default, this parameter is not specified. The supported value is `LastNonCompliantRecordTimestamp-Asc`. This value sorts resources based on the time when they first became non-compliant, in ascending order. You must set the `ComplianceType` parameter to `NON_COMPLIANT`.	LastNonCompliantRecordTimestamp-Asc
ComplianceType	string	No	The compliance evaluation result. Valid values: COMPLIANT: The resource is compliant. NON_COMPLIANT: The resource is non-compliant. NOT_APPLICABLE: The rule does not apply to the resource. INSUFFICIENT_DATA: No data is available for the resource. IGNORED: The evaluation result is ignored.	NON_COMPLIANT
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If the response is truncated, you can use this token to initiate another request to retrieve the remaining records.	IWBjqMYSy0is7zSMGu16****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100.	10
Region	string	No	The ID of the region where the resource resides. For example, `global` indicates Global and `cn-hangzhou` indicates China (Hangzhou). For more information about how to obtain the region ID of a resource, see ListAggregateDiscoveredResources.	global
AggregatorId	string	Yes	The ID of the account group. For more information about how to obtain the ID of an account group, see ListAggregators.	ca-7f00626622af0041****

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

Response elements

Element	Type	Description	Example
	object	None.
RequestId	string	The request ID.	25C89DDB-BB79-487D-88C3-4A561F21EFC4
EvaluationResults	object	The evaluation results of the resources.
NextToken	string	The token that is used to retrieve the next page of results.	IWBjqMYSy0is7zSMGu16****
MaxResults	integer	The maximum number of entries returned per page.	10
EvaluationResultList	array<object>	A list of resource evaluation results.
	object	None.
RiskLevel	integer	The risk level of the rule. Valid values: 1: high 2: medium 3: low	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 does not apply to the resource. INSUFFICIENT_DATA: No data is available for the resource. IGNORED: The evaluation result is ignored.	NON_COMPLIANT
ResultRecordedTimestamp	integer	The timestamp when the evaluation result was recorded. Unit: milliseconds.	1624932227595
Annotation	string	The supplementary information about the non-compliant resource.	{\"configuration\":\"false\",\"desiredValue\":\"True\",\"operator\":\"StringEquals\",\"property\":\"$.LoginProfile.MFABindRequired\"}
ConfigRuleInvokedTimestamp	integer	The timestamp when the rule was invoked to evaluate the resource. Unit: milliseconds.	1624932227157
InvokingEventMessageType	string	The trigger type of the rule. Valid values: ConfigurationItemChangeNotification: The rule is triggered by a configuration change. ScheduledNotification: The rule is triggered periodically.	ScheduledNotification
EvaluationResultIdentifier	object	The identifier of the resource evaluation result.
OrderingTimestamp	integer	The timestamp displayed on the timeline. Unit: milliseconds.	1624932227157
EvaluationResultQualifier	object	The resource information in the evaluation result.
ConfigRuleArn	string	The ARN of the rule.	acs:config::100931896542**:rule/cr-7f7d626622af0041**
ResourceType	string	The resource type.	ACS::RAM::User
ConfigRuleName	string	The rule name.	ram-user-mfa-check
ResourceId	string	The resource ID.	23642660635396****
ConfigRuleId	string	The rule ID.	cr-7f7d626622af0041****
ResourceName	string	The resource name.	rd_member
RegionId	string	The ID of the region where the resource resides.	global
IgnoreDate	string	The date on which the ignored evaluation result is automatically resumed. Note If this parameter is empty, the result is not automatically resumed. You must manually resume the result.	2022-06-01
ResourceOwnerId	integer	The ID of the Alibaba Cloud account to which the resource belongs.	120886317861****
RemediationEnabled	boolean	Indicates whether remediation is enabled. Valid values: true: Remediation is enabled. false: Remediation is not enabled.	false
EvaluationId	string	The unique ID of the evaluation result.	00000089-4e0d-58b5-a96a-8e54112110f3
LastNonCompliantRecordTimestamp	integer	The timestamp when the resource last became non-compliant.	1744696665000

Examples

Success response

JSON format

{
  "RequestId": "25C89DDB-BB79-487D-88C3-4A561F21EFC4",
  "EvaluationResults": {
    "NextToken": "IWBjqMYSy0is7zSMGu16****",
    "MaxResults": 10,
    "EvaluationResultList": [
      {
        "RiskLevel": 1,
        "ComplianceType": "NON_COMPLIANT",
        "ResultRecordedTimestamp": 1624932227595,
        "Annotation": "{\\\"configuration\\\":\\\"false\\\",\\\"desiredValue\\\":\\\"True\\\",\\\"operator\\\":\\\"StringEquals\\\",\\\"property\\\":\\\"$.LoginProfile.MFABindRequired\\\"}",
        "ConfigRuleInvokedTimestamp": 1624932227157,
        "InvokingEventMessageType": "ScheduledNotification",
        "EvaluationResultIdentifier": {
          "OrderingTimestamp": 1624932227157,
          "EvaluationResultQualifier": {
            "ConfigRuleArn": "acs:config::100931896542****:rule/cr-7f7d626622af0041****",
            "ResourceType": "ACS::RAM::User",
            "ConfigRuleName": "ram-user-mfa-check",
            "ResourceId": "23642660635396****",
            "ConfigRuleId": "cr-7f7d626622af0041****",
            "ResourceName": "rd_member",
            "RegionId": "global",
            "IgnoreDate": "2022-06-01",
            "ResourceOwnerId": 0
          }
        },
        "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.
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.	The specified aggregator ID does not exist or you are not authorized to use the aggregator.
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.