Create a remediation for a rule in an account group using CreateAggregateRemediation - Cloud Config - Alibaba Cloud - Cloud Config

Operation description

Background information

Template remediation: Uses public templates provided by CloudOps Orchestration Service (OOS) to quickly remediate non-compliant resources.

Each rule supports only one remediation setting, and only rules created by using specific templates support template remediation.
Custom remediation: Uses custom code run by Function Compute to quickly remediate non-compliant resources.

Each rule supports only one remediation setting. Both rules created by using templates and custom rules are supported.

Scenarios

This topic provides an example on how to create a remediation setting for the rule cr-6b7c626622af00b4**** in the account group ca-6b4a626622af0012****. 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:CreateAggregateRemediation

create

*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 ListAggregateConfigRules.	cr-6b7c626622af00b4****
RemediationType	string	Yes	The remediation type. Valid values: OOS: CloudOps Orchestration Service (template remediation). FC: Function Compute (custom remediation).	OOS
RemediationTemplateId	string	Yes	The remediation template ID. If RemediationType is set to `OOS`, this parameter is set to `ACS-OSS-PutBucketAcl`. For information about how to obtain the remediation template ID, see ListRemediationTemplates. If RemediationType is set to `FC`, this parameter is set to the Alibaba Cloud Resource Name (ARN) of the function, such as `acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/test-php`.	ACS-OSS-PutBucketAcl
InvokeType	string	Yes	The execution mode of the remediation. Valid values: NON_EXECUTION: not executed. AUTO_EXECUTION: automatically executed. MANUAL_EXECUTION: manually executed. NOT_CONFIG: not configured.	MANUAL_EXECUTION
SourceType	string	No	The source of the remediation template. Valid values: ALIYUN (default): Chinese site template. CUSTOM: custom template. (Set this value for custom FC remediation.) NONE: none.	ALIYUN
Params	string	Yes	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"}
AggregatorId	string	Yes	The account group ID. For information about how to obtain the account group ID, see ListAggregators.	ca-6b4a626622af0012****
ClientToken	string	No	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 ClientToken parameter supports only ASCII characters and cannot exceed 64 characters in length.	AAAAAdDWBF2****

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
RemediationId	string	The remediation setting ID.	crr-909ba2d4716700eb****

Examples

Success response

JSON format

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

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.
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.