DisableKey - 禁用指定的主密钥(CMK)进行加解密

禁用指定的主密钥(CMK)进行加解密。

接口说明

  • RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制

  • 禁用主密钥后,原来使用该主密钥加密的密文无法解密。您可以调用 EnableKey 将主密钥恢复至启用状态,然后解密密文。

本文将提供一个示例,禁用 ID 为1234abcd-12ab-34cd-56ef-12345678****的主密钥进行加解密。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

密钥 ID。主密钥的全局唯一标识符。

1234abcd-12ab-34cd-56ef-12345678****

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

2fe70ce2-3303-4fd6-b3ac-472fb2705c62

示例

正常返回示例

JSON格式

{
  "RequestId": "2fe70ce2-3303-4fd6-b3ac-472fb2705c62"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is not valid.参数非法。
404Forbidden.KeyNotFoundThe specified Key is not found.指定的密钥不存在。
404InvalidAccessKeyId.NotFoundThe Access Key ID provided does not exist in our records.-

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