Call CreateRemediation to create a remediation for a rule - Cloud Config - Alibaba Cloud - Cloud Config

Operation description

Background information

Template remediation: Quickly remediates non-compliant resources by using public templates provided by CloudOps Orchestration Service (OOS).

You can configure only one remediation for a rule. Only rules created by using specific templates support template remediation.
Custom remediation: Quickly remediates non-compliant resources by running custom code in Function Compute (FC).

You can configure only one remediation for a rule. Both rules created by using templates and custom rules are supported.

Instructions

This topic provides an example to show how to create a remediation setting for the rule cr-8a973ac2e2be00a2****. The response shows that the remediation setting is created and the remediation setting ID is crr-909ba2d4716700eb****.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleId	string	Yes	Specifies whether to perform a dry run on the request. Valid values: true: performs a dry run. The system checks the request parameters and business logic but does not perform the actual operation. If the dry run succeeds, the DryRunOperation error code is returned. If the dry run fails, the corresponding error code is returned. false: performs the request. This is the default value.	false
RemediationType	string	Yes	The ID of the rule. For information about how to obtain the rule ID, see ListConfigRules.	cr-8a973ac2e2be00a2****
RemediationTemplateId	string	Yes	The remediation type. Valid values: OOS: CloudOps Orchestration Service (template remediation). FC: Function Compute (custom remediation).	OOS
InvokeType	string	Yes	The ID of the remediation template. If `RemediationType` is set to `OOS`, set this parameter to `ACS-OSS-PutBucketAcl`. For information about how to obtain the remediation template ID, see ListRemediationTemplates. If `RemediationType` is set to `FC`, set this parameter to the ARN of the Function Compute function. Example: `acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/test-php`.	ACS-OSS-PutBucketAcl
SourceType	string	No	The execution method of the remediation. Valid values: NON_EXECUTION: does not execute the remediation. AUTO_EXECUTION: automatically executes the remediation. MANUAL_EXECUTION: manually executes the remediation. NOT_CONFIG: not configured.	MANUAL_EXECUTION
Params	string	Yes	The source of the template used to execute the remediation. Valid values: ALIYUN: official template. This is the default value. CUSTOM: custom template. Set this parameter to CUSTOM when you configure a custom FC remediation. NONE: none.	ALIYUN
ClientToken	string	No	The parameters of the remediation setting. For information about how to obtain the parameters of the remediation setting, see the `TemplateDefinition` parameter in ListRemediationTemplates.	{"bucketName": "{resourceId}", "regionId": "{regionId}", "permissionName": "private"}

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

Response elements

Element	Type	Description	Example
	object	None.
RemediationId	string	The ID of the remediation setting.	crr-909ba2d4716700eb****
RequestId	string	The ID of the request.	C7817373-78CB-4F9A-8AFA-E7A88E9D64A2

Examples

Success response

JSON format

{
  "RemediationId": "crr-909ba2d4716700eb****",
  "RequestId": "C7817373-78CB-4F9A-8AFA-E7A88E9D64A2"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ConfigRuleNotExists	The ConfigRule does not exist.	The rule does not exist.
400	RemediationInputParamInConsistentWithRule	The remediation parameter does not match the rule parameter.	The remediation parameter does not match the rule parameter.
400	RemediationTemplateNotExist	The remediation template does not exist or is invalid.	The remediation template does not exist or is invalid.
400	Invalid.Params.Value	The specified parameter value is invalid.	The specified parameter value is invalid.
400	DryRunOperation	Request validation has been passed with DryRun flag set.
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.