Queries the detailed information about the remediation template for a managed rule.

In this topic, the oss-bucket-public-write-prohibited managed rule is used as an example. The return result shows the detailed information about the remediation template of the OOS type for the managed rule. OOS represents Operation Orchestration Service.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListRemediationTemplates

The operation that you want to perform. Set the value to ListRemediationTemplates.

RemediationType String No OOS

The type of the remediation template. Valid value: OOS, which stands for Operation Orchestration Service.

ManagedRuleIdentifier String Yes oss-bucket-public-write-prohibited

The identifier of the managed rule.

For information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String FC2C4750-7024-499C-A69F-763543D1CBE3

The ID of the request.

RemediationTemplates Array of RemediationTemplate

The information about the remediation template.

RemediationType String OOS

The type of the remediation template. Valid value: OOS, which stands for Operation Orchestration Service.

TemplateIdentifier String ACS-OSS-PutBucketAcl

The ID of the remediation template.

TemplateName String Set the ACL of an OSS bucket to private.

The name of the remediation template.

TemplateDefinition String {\n \"Parameters\": {\n \"regionId\": {\n \"Type\": \"String\",\n \"Description\": \"The id of target region.\",\n \"AssociationProperty\": \"RegionId\",\n \"Default\": \"{regionId}\"\n },\n \"bucketName\": {\n \"Description\": {\n \"en\": \"The OSS bucket name.\",\n \"zh-cn\": \"\"\n },\n \"Type\": \"String\",\n \"Default\": \"{resourceId}\"\n },\n \"permissionName\": {\n \"Description\": {\n \"en\": \"The acl permission name.\",\n \"zh-cn\": \"\"\n },\n \"Type\": \"String\",\n \"Default\": \"private\",\n \"AllowedValues\": [\n \"public-read-write\",\n \"public-read\",\n \"private\"\n ]\n }\n }\n}

The configuration of the remediation template.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListRemediationTemplates
&ManagedRuleIdentifier=oss-bucket-public-write-prohibited
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListRemediationTemplatesResponse>
    <RequestId>B62CE8A9-8FED-432A-B51E-EADBD1450B5C</RequestId>
    <RemediationTemplates>
        <TemplateIdentifier>ACS-OSS-PutBucketAcl</TemplateIdentifier>
        <TemplateName>Set the ACL of an OSS bucket to private.</TemplateName>
        <TemplateDefinition>
            {\n  \"Parameters\": {\n    \"regionId\": {\n      \"Type\": \"String\",\n      \"Description\": \"The id of target region.\",\n      \"AssociationProperty\": \"RegionId\",\n      \"Default\": \"{regionId}\"\n    },\n    \"bucketName\": {\n      \"Description\": {\n        \"en\": \"The OSS bucket name.\",\n        \"zh-cn\": \"\"\n      },\n      \"Type\": \"String\",\n      \"Default\": \"{resourceId}\"\n    },\n    \"permissionName\": {\n      \"Description\": {\n        \"en\": \"The acl permission name.\",\n        \"zh-cn\": \"\"\n      },\n      \"Type\": \"String\",\n      \"Default\": \"private\",\n      \"AllowedValues\": [\n        \"public-read-write\",\n        \"public-read\",\n        \"private\"\n      ]\n    }\n  }\n}</TemplateDefinition>
        <RemediationType>OOS</RemediationType>
    </RemediationTemplates>
</ListRemediationTemplatesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "B62CE8A9-8FED-432A-B51E-EADBD1450B5C",
  "RemediationTemplates" : [ {
    "TemplateIdentifier" : "ACS-OSS-PutBucketAcl",
    "TemplateName" : "Set the ACL of an OSS bucket to private.",
    "TemplateDefinition" : "{\n  \"Parameters\": {\n    \"regionId\": {\n      \"Type\": \"String\",\n      \"Description\": \"The id of target region.\",\n      \"AssociationProperty\": \"RegionId\",\n      \"Default\": \"{regionId}\"\n    },\n    \"bucketName\": {\n      \"Description\": {\n        \"en\": \"The OSS bucket name.\",\n        \"zh-cn\": \"\"\n      },\n      \"Type\": \"String\",\n      \"Default\": \"{resourceId}\"\n    },\n    \"permissionName\": {\n      \"Description\": {\n        \"en\": \"The acl permission name.\",\n        \"zh-cn\": \"\"\n      },\n      \"Type\": \"String\",\n      \"Default\": \"private\",\n      \"AllowedValues\": [\n        \"public-read-write\",\n        \"public-read\",\n        \"private\"\n      ]\n    }\n  }\n}",
    "RemediationType" : "OOS"
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 NoPermission You are not authorized to perform this operation. The error message returned because you are not authorized to perform the specified operation.
503 ServiceUnavailable The request has failed due to a temporary failure of the server. The error message returned because the service is unavailable.

For a list of error codes, visit the API Error Center.