Query remediation templates using ListRemediationTemplates - Cloud Config - Alibaba Cloud - Cloud Config

Operation description

The oss-bucket-public-write-prohibited managed rule is used as an example. The response returns the details of the OOS (Operation Orchestration Service) remediation template for this rule.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RemediationType	string	No	The type of the remediation template. Valid value: OOS, which stands for Operation Orchestration Service.	OOS
ManagedRuleIdentifier	string	No	The identifier of the managed rule. You can call the ListCompliancePackTemplates operation to obtain the managed rule identifier.	oss-bucket-public-write-prohibited
PageNumber	integer	No	The page number. Pages start from 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100.	20

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

Response elements

Element	Type	Description	Example
	object	None.
RequestId	string	The request ID.	FC2C4750-7024-499C-A69F-763543D1CBE3
RemediationTemplates	array<object>	The remediation templates.
	object
RemediationType	string	The type of the remediation template. Valid value: OOS, which indicates Operation Orchestration Service.	OOS
TemplateIdentifier	string	The ID of the remediation template.	ACS-OSS-PutBucketAcl
TemplateName	string	The name of the remediation template.	设置OSS Bucket的访问权限为私有。
TemplateDefinition	string	The definition of the remediation template.	{ "Parameters": { "bucketName": { "Default": "{resourceId}", "Description": { "zh-cn": "[Required]OSS Bucket名称。", "en": "[Required]OSS Bucket名称。" }, "Type": "String" }, "regionId": { "AssociationProperty": "RegionId", "Default": "{regionId}", "Description": { "zh-cn": "[Required]The id of target region.", "en": "[Required]The id of target region." }, "Type": "String" }, "permissionName": { "AllowValues": "[\"public-read-write\",\"public-read\",\"private\"]", "Default": "private", "Description": { "zh-cn": "[Required]ACL权限名称。", "en": "[Required]ACL权限名称。" }, "Type": "String" } } }
TemplateDescription	string	The description of the remediation template.	通过接口PutBucketACL，设置或修改存储空间（Bucket）的访问权限（ACL），请您知晓风险谨慎操作。
PageNumber	integer	The page number. Pages start from 1.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 100.	10
TotalCount	string	The total number of remediation templates.	1

Examples

Success response

JSON format

{
  "RequestId": "FC2C4750-7024-499C-A69F-763543D1CBE3",
  "RemediationTemplates": [
    {
      "RemediationType": "OOS",
      "TemplateIdentifier": "ACS-OSS-PutBucketAcl",
      "TemplateName": "设置OSS Bucket的访问权限为私有。",
      "TemplateDefinition": "{   \"Parameters\": {     \"bucketName\": {       \"Default\": \"{resourceId}\",       \"Description\": {         \"zh-cn\": \"[Required]OSS Bucket名称。\",         \"en\": \"[Required]OSS Bucket名称。\"       },       \"Type\": \"String\"     },     \"regionId\": {       \"AssociationProperty\": \"RegionId\",       \"Default\": \"{regionId}\",       \"Description\": {         \"zh-cn\": \"[Required]The id of target region.\",         \"en\": \"[Required]The id of target region.\"       },       \"Type\": \"String\"     },     \"permissionName\": {       \"AllowValues\": \"[\\\"public-read-write\\\",\\\"public-read\\\",\\\"private\\\"]\",       \"Default\": \"private\",       \"Description\": {         \"zh-cn\": \"[Required]ACL权限名称。\",         \"en\": \"[Required]ACL权限名称。\"       },       \"Type\": \"String\"     }   } }",
      "TemplateDescription": "通过接口PutBucketACL，设置或修改存储空间（Bucket）的访问权限（ACL），请您知晓风险谨慎操作。"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": "1"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	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.