ListRemediationTemplates - Cloud Config - Alibaba Cloud Documentation Center

Note

This API has been deprecated. We recommend migrating to Config(2020-09-07) - ListRemediationTemplates for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Operation description

This topic provides an example of how to query the details of the remediation template for the managed rule oss-bucket-public-write-prohibited. The response shows the details of the template for the OOS remediation type.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RemediationType	string	No	The remediation type. Only OOS is supported.	OOS
ManagedRuleIdentifier	string	Yes	The identifier of the managed rule.	oss-bucket-public-write-prohibited

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

Response elements

Parameter	Type	Description	Example
	object
RemediationTemplates	array<object>	The list of remediation templates.
	object
RemediationType	string	The remediation type. Only OOS is supported.	OOS
TemplateDefinition	string	The definition of the remediation template.
TemplateIdentifier	string	The ID of the remediation template.	ACS-OSS-PutBucketAcl
TemplateName	string	The name of the remediation template.	Set the ACL of an OSS bucket to private.
RequestId	string	The ID of the request.	FC2C4750-7024-499C-A69F-763543D1CBE3

Examples

Success response

JSON format

{
  "RemediationTemplates": [
    {
      "RemediationType": "OOS",
      "TemplateDefinition": "",
      "TemplateIdentifier": "ACS-OSS-PutBucketAcl",
      "TemplateName": "Set the ACL of an OSS bucket to private."
    }
  ],
  "RequestId": "FC2C4750-7024-499C-A69F-763543D1CBE3"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.