Use StartAggregateConfigRuleEvaluation to re-evaluate resource compliance in an account group - Cloud Config - Alibaba Cloud - Cloud Config

Operation description

Note

After 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 shows how to use the cr-c169626622af009f**** rule in the ca-3a58626622af0005**** account group to evaluate resources.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleId	string	No	The rule ID. To query the ID of a rule, see ListAggregateConfigRules. Note You must configure either the `CompliancePackId` or `ConfigRuleId` parameter.	cr-c169626622af009f****
AggregatorId	string	Yes	The ID of the account group. To obtain the ID of an account group, see ListAggregators.	ca-3a58626622af0005****
RevertEvaluation	boolean	No	Whether to re-evaluate ignored non-compliant resources. Valid values: true: re-evaluates the ignored non-compliant resource based on the rule. false (default): does not re-evaluate the ignored non-compliant resource based on the rule.	false
CompliancePackId	string	No	The ID of the compliance package. To obtain the ID of a compliance package, see ListAggregateCompliancePacks. Note You must configure either the `CompliancePackId` or `ConfigRuleId` parameter.	cp-ac16626622af0053****

For common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	N/A.
RequestId	string	The request ID.	ABC0FFF8-0B44-40C6-8BBF-3A185EFDD212
Result	boolean	Whether the involved resources were evaluated. Valid values: true: The involved resources were evaluated. false: The involved resources were not evaluated	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	ConfigRuleNotExists	The ConfigRule does not exist.
400	NoPermission	You are not authorized to perform this operation.
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.
403	AggregatorMemberNoPermission	The aggregator member is not authorized to perform the operation.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	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.