获取修正模板列表信息。
接口说明
本文将提供一个示例,查询托管规则oss-bucket-public-write-prohibited的修正模板详情。返回结果为修正类型OOS(运维编排)的模板详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
config:ListRemediationTemplates |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RemediationType |
string |
否 |
修正类型。仅支持 OOS(运维编排)。 |
OOS |
| ManagedRuleIdentifier |
string |
否 |
规则模板标识。 关于如何获取规则模板标识,请参见 ListCompliancePackTemplates 。 |
oss-bucket-public-write-prohibited |
| PageNumber |
integer |
否 |
修正模板列表的页码。起始值:1。 |
1 |
| PageSize |
integer |
否 |
分页查询时设置的每页行数。 取值范围:1~100,默认值:20。 |
20 |
关于公共请求参数的详情,请参见公共参数。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
无。 |
||
| RequestId |
string |
请求 ID。 |
FC2C4750-7024-499C-A69F-763543D1CBE3 |
| RemediationTemplates |
array<object> |
修正模板列表。 |
|
|
object |
无。 |
||
| RemediationType |
string |
修正类型。仅支持 OOS(运维编排)。 |
OOS |
| TemplateIdentifier |
string |
修正模板 ID。 |
ACS-OSS-PutBucketAcl |
| TemplateName |
string |
修正模板名称。 |
设置OSS Bucket的访问权限为私有。 |
| TemplateDefinition |
string |
修正模板定义。 |
{ "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 |
修正模板描述。 |
通过接口PutBucketACL,设置或修改存储空间(Bucket)的访问权限(ACL),请您知晓风险谨慎操作。 |
| PageNumber |
integer |
修正模板列表的页码。起始值:1。 |
1 |
| PageSize |
integer |
分页查询时设置的每页行数。取值范围:1~100。 |
10 |
| TotalCount |
string |
修正模板总数。 |
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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | NoPermission | You are not authorized to perform this operation. | 您无权执行此操作。 |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 服务不可用。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。