All Products
Search
Document Center

Cloud Config:CreateRemediation

Last Updated:Mar 08, 2023

Configures a remediation template for a rule.

Operation Description

In this topic, the rule whose ID is cr-8a973ac2e2be00a2**** is used as an example. The return result shows that a remediation template is configured and the ID of the remediation setting is crr-909ba2d4716700eb****.

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 keyAssociation operation
config:CreateRemediationWrite
  • Config
    acs:config:*:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdstringYes

The ID of the rule.

You can call the ListConfigRules operation to obtain the rule ID.

cr-8a973ac2e2be00a2****
RemediationTypestringYes

The type of remediation to perform. Valid values:

  • OOS: stands for Operation Orchestration Service and indicates official remediation.
  • FC: stands for Function Compute and indicates custom remediation.
OOS
RemediationTemplateIdstringYes

The identifier of the remediation template.

  • If you set the RemediationType parameter to OOS, set this parameter to the identifier of the relevant official remediation template, such as ACS-OSS-PutBucketAcl. You can call the ListRemediationTemplates operation to obtain the remediation template identifier.
  • If you set the RemediationType parameter to FC, set this parameter to the Alibaba Cloud Resource Name (ARN) of the relevant Function Compute resource, such as acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/test-php.
ACS-OSS-PutBucketAcl
InvokeTypestringYes

The execution mode of the remediation template. Valid values:

  • NON_EXECUTION: no execution.
  • AUTO_EXECUTION: automatic execution.
  • MANUAL_EXECUTION: manual execution.
  • NOT_CONFIG: not specified.
MANUAL_EXECUTION
SourceTypestringNo

The source of remediation. Valid values:

  • ALIYUN: official template. This is the default value.
  • CUSTOM: custom template.
  • NONE: none.
ALIYUN
ParamsstringYes

The configuration of the remediation template.

You can call the ListRemediationTemplates operation to obtain the remediation template configuration from the TemplateDefinition response parameter.

{"bucketName": "{resourceId}", "regionId": "{regionId}", "permissionName": "private"}
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length.

AAAAAdDWBF2****

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The ID of the remediation setting.

crr-909ba2d4716700eb****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400ConfigRuleNotExistsThe ConfigRule does not exist.The rule does not exist.
400RemediationInputParamInConsistentWithRuleThe remediation parameter does not match the rule parameter.The remediation parameter does not match the rule parameter.
400RemediationTemplateNotExistThe remediation template does not exist or is invalid.The remediation template does not exist or is invalid.
400Invalid.Params.ValueThe specified parameter value is invalid.The specified parameter value is invalid.
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.