Fix Non-Compliant Resources via StartRemediation - Cloud Config - Alibaba Cloud - Cloud Config

Operation description

This topic provides an example on how to manually execute remediation for the rule cr-8a973ac2e2be00a2****. The response shows that the remediation is executed.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleId	string	Yes	The rule ID. For information about how to obtain the rule ID, see ListConfigRules.	cr-8a973ac2e2be00a2****
ResourceId	string	No	The resource ID for single-resource remediation. Example: vpc-xxx.	vpc-xxx
ResourceType	string	No	The resource type for single-resource remediation. Example: ACS::VPC::VPC.	ACS::VPC::VPC
ResourceRegionId	string	No	The region ID of the resource for single-resource remediation. Example: cn-hangzhou.	cn-hangzhou

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

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	C7817373-78CB-4F9A-8AFA-E7A88E9D64A2
Data	boolean	Indicates whether the operation is successful. Valid values: true: The operation is successful. false: The operation failed.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	RemediationTemplateNotExist	The remediation template does not exist or is invalid.	The remediation template does not exist or is invalid.
400	RemediationInputParamInConsistentWithRule	The remediation parameter does not match the rule parameter.	The remediation parameter does not match the rule parameter.
403	NoPermissionCreateRemediationSLR	No permission to create service linked role: AliyunServiceRoleForConfigRemediation.	You have no permission to create the service-linked role: AliyunServiceRoleForConfigRemediation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.