StartAggregateRemediation - Cloud Config - Alibaba Cloud Documentation Center

Performs a remediation operation by using a rule in an account group.

Operation description

This topic provides an example on how to manually perform a remediation operation by using the rule whose ID is cr-6b7c626622af00b4**** in the account group whose ID is ca-6b4a626622af0012****. The return result shows that the manual execution is successful.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

Operation	Access level	Resource type	Condition key	Associated operation
config:StartAggregateRemediation	Write	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleId	string	Yes	The rule ID. For more information about how to obtain the ID of a rule, see ListAggregateConfigRules .	cr-6b7c626622af00b4****
AggregatorId	string	Yes	The ID of the account group. For information about how to obtain the ID of an account group, see ListAggregators .	ca-6b4a626622af0012****
ResourceAccountId	long	No	The ID of the Alibaba Cloud account to which the resources to be remediated belong. If this parameter is left empty, non-compliant resources of all accounts in the account group are remediated. Note You must specify the ID of the current management account or a member account in the account group of the management account.	100271897542****

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

Response parameters

Parameter	Type	Description	Example
	object	None
RequestId	string	The request ID.	C7817373-78CB-4F9A-8AFA-E7A88E9D64A2
Data	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "C7817373-78CB-4F9A-8AFA-E7A88E9D64A2",
  "Data": true
}

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	AccountNotExisted	Your account does not exist.	The specified 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.

Change history

Change time

Summary of changes

Operation

2023-05-17

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 503
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ResourceAccountId