文档

ListRemediationTemplates - 获取修正模板列表

更新时间:

获取修正模板列表信息。

接口说明

本文将提供一个示例,查询托管规则oss-bucket-public-write-prohibited的修正模板详情。返回结果为修正类型OOS(运维编排)的模板详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
config:ListRemediationTemplatesList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RemediationTypestring

修正类型。仅支持 OOS(运维编排)。

OOS
ManagedRuleIdentifierstring

托管规则标识。

关于如何获取托管规则标识,请参见 ListCompliancePackTemplates

oss-bucket-public-write-prohibited
PageNumberlong

修正模板列表的页码。起始值:1。

1
PageSizelong

分页查询时设置的每页行数。取值范围:1~100。

10

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

RequestIdstring

请求 ID。

FC2C4750-7024-499C-A69F-763543D1CBE3
RemediationTemplatesobject []

修正模板列表。

RemediationTypestring

修正类型。仅支持 OOS(运维编排)。

OOS
TemplateIdentifierstring

修正模板 ID。

ACS-OSS-PutBucketAcl
TemplateNamestring

修正模板名称。

设置OSS Bucket的访问权限为私有。
TemplateDefinitionstring

修正模板定义。

{ "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" } } }
TemplateDescriptionstring

修正模板描述。

通过接口PutBucketACL,设置或修改存储空间(Bucket)的访问权限(ACL),请您知晓风险谨慎操作。
PageNumberlong

修正模板列表的页码。起始值:1。

1
PageSizelong

分页查询时设置的每页行数。取值范围:1~100。

10
TotalCountstring

修正模板总数。

1

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-13OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:PageNumber
    新增入参:PageSize
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈