为用户主密钥（CMK）开启或关闭删除保护。
接口说明
-
RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。
-
当您为 CMK 开启删除保护后，将无法删除该 CMK。如果需要删除 CMK，需提前关闭删除保护。
-
调用 SetDeletionProtection 接口前，请确保 CMK 不处于待删除状态。您可以调用 DescribeKey 接口查看 CMK 的状态（KeyState）。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
kms:SetDeletionProtection |
update |
*Key
|
|
无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProtectedResourceArn |
string |
否 |
待设置删除保护的 CMK ARN。 |
acs:kms:cn-hangzhou:123213123****:key/0225f411-b21d-46d1-be5b-93931c82**** |
| EnableDeletionProtection |
boolean |
是 |
是否开启删除保护，取值：
|
true |
| DeletionProtectionDescription |
string |
否 |
删除保护描述。 说明
当 EnableDeletionProtection 取值为 true 时该参数有效。 |
The CMK is being used by XXX. Deletion protection is set. |
| KeyId |
string |
否 |
密钥的 ID。 |
key-hzz65f3a68554s6ms**** |
| KmsInstanceId |
string |
否 |
关于公共请求参数的详情，请参见公共参数。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。 |
3455b9b4-95c1-419d-b310-db6a53b09a39 |
示例
正常返回示例
JSON格式
{
"RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。