All Products
Search

This Product

    Cloud Config:CreateRemediation

    Document Center

    Cloud Config:CreateRemediation

    Last Updated:Jun 17, 2024

    Creates a remediation template for a rule.

    Operation description

    This topic provides an example on how to create a remediation template for the rule cr-8a973ac2e2be00a2****. The returned result shows that a remediation template is created and the ID of the remediation template is crr-909ba2d4716700eb****.

    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:CreateRemediationWrite
    • 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****
    RemediationTypestringYes

    The type of the remediation template. Valid values:

    • OOS: Operation Orchestration Service (official remediation)
    • FC: Function Compute (custom remediation)
    		OOS
    RemediationTemplateIdstringYes

    The ID 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. For more information about how to obtain the remediation template identifier, see ListRemediationTemplates .
    • 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: The remediation template is not executed.
    • AUTO_EXECUTION: The remediation template is automatically executed.
    • MANUAL_EXECUTION: The remediation template is manually executed.
    • NOT_CONFIG: The execution mode is not specified.
    		MANUAL_EXECUTION
    SourceTypestringNo

    The source of remediation. Valid values:

    • ALIYUN (default): official template.
    • CUSTOM: custom template.
    • NONE: none.
    		ALIYUN
    ParamsstringYes

    The configuration of the remediation template.

    For more information about how to obtain the remediation template configuration, see the TemplateDefinition response parameter provided in ListRemediationTemplates .

    		{"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 token, but you must make sure that the token is unique among different requests. The token 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

    N/A.

    RequestIdstring

    The request ID.

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

    The ID of the remediation template.

    		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.

    Change history

    Change timeSummary of changesOperation
    No change history