申请删除一个指定的主密钥（CMK)。
接口说明
-
RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。
-
在密钥预删除期间，密钥状态处于待删除状态，无法用于加密、解密、产生数据密钥操作。
-
主密钥一旦删除，将无法恢复，使用该主密钥加密的内容及产生的数据密钥也将无法解密。因此，对于主密钥的删除，KMS 只提供计划删除的方式，而不提供直接删除的方式。如果您有删除密钥方面的需求，可以通过 DisableKey 禁用密钥。
-
在申请删除主密钥的同时，需要指定一个预删除周期，该周期最少为 7 天，最多为 366 天。从申请删除主密钥的时刻开始，到删除周期之前，可以通过 CancelKeyDeletion 撤销密钥删除的申请。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| KeyId | string | 是 | 密钥 ID。CMK 全局唯一标识符。 | 7906979c-8e06-46a2-be2d-68e3ccbc**** |
| PendingWindowInDays | integer | 是 | 密钥预删除周期。在这段时间内，您可以撤销删除处于待删除状态的密钥；预删除时间过后无法撤销删除。 | 7 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "3da5b8cc-8107-40ac-a170-793cd181d7b7"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is not valid. | 参数非法。 |
| 404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-08-18 | API 内部配置变更，不影响调用 | 查看变更详情 |