All Products
Document Center

Cloud Config:StartAggregateConfigRuleEvaluation

Last Updated:Mar 08, 2023

Uses a rule in an account group or in a compliance package to evaluate the compliance of resources.

Operation Description

NoteAfter you call this operation, the compliance evaluation is performed only once. To query the compliance evaluation results returned by the rule, call the ListAggregateConfigRuleEvaluationResults operation. For more information, see ListAggregateConfigRuleEvaluationResults.

The sample request in this topic shows you how to use the cr-c169626622af009f**** rule in the ca-3a58626622af0005**** account group to evaluate resources.

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.
OperationAccess levelResource typeCondition keyAssociation operation
  • Config

Request parameters


The ID of the rule.

For more information about how to obtain the ID of a rule, see ListAggregateConfigRules.


The ID of the account group.

For more information about how to obtain the ID of an account group, see ListAggregators.


Specifies whether to re-evaluate the ignored non-compliant resource. Valid values:

  • true: re-evaluates the ignored non-compliant resource based on the rule.
  • false: continues to ignore the resource in the compliance evaluation based on the rule.

The ID of the compliance package.

For more information about how to obtain the ID of a compliance package, see ListAggregateCompliancePacks.

NoteYou must set either the CompliancePackId or ConfigRuleId parameter.

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

Response parameters


The ID of the request.


Indicates whether the operation is successful. Valid values:

  • true: The operation is successful.
  • false: The operation fails.


Sample success responses


  "RequestId": "ABC0FFF8-0B44-40C6-8BBF-3A185EFDD212",
  "Result": true

Error codes

HTTP status codeError codeError messageDescription
400ConfigRuleNotExistsThe ConfigRule does not exist.The rule does not exist.
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
403AggregatorMemberNoPermissionThe aggregator member is not authorized to perform the operation.The aggregator member is not authorized to perform the operation.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe 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.