All Products
Search
Document Center

Cloud Config:StartRemediation

Last Updated:Jun 17, 2024

Performs a remediation operation by using a rule.

Operation description

This topic provides an example on how to perform a remediation operation by using the rule whose ID is cr-8a973ac2e2be00a2****. The returned 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.

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 keyAssociated operation
config:StartRemediationWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdstringYes

The rule ID.

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

cr-8a973ac2e2be00a2****

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

Response parameters

ParameterTypeDescriptionExample
object

N/A.

RequestIdstring

The request ID.

C7817373-78CB-4F9A-8AFA-E7A88E9D64A2
Databoolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400RemediationTemplateNotExistThe remediation template does not exist or is invalid.The remediation template does not exist or is invalid.
400RemediationInputParamInConsistentWithRuleThe remediation parameter does not match the rule parameter.The remediation parameter does not match the rule parameter.
403NoPermissionCreateRemediationSLRNo permission to create service linked role: AliyunServiceRoleForConfigRemediation.You have no permission to create the service-linked role: AliyunServiceRoleForConfigRemediation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history