CMK计划删除接口

最近更新时间:2019-07-24 15:23:19

1. 接口描述

接口请求域名: kms.tencentcloudapi.com 。

CMK计划删除接口,用于指定CMK删除的时间,可选时间区间为[7,30]天

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ScheduleKeyDeletion
Version String 公共参数,本接口取值:2019-01-18
Region String 公共参数,详见产品支持的 地域列表
KeyId String CMK的唯一标志
PendingWindowInDays Integer 计划删除时间区间[7,30]

3. 输出参数

参数名称 类型 描述
DeletionDate Integer 计划删除执行时间
KeyId String 唯一标志被计划删除的CMK
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 计划删除接口请求示例

指定CMK于累计7天后被删除

输入示例

https://kms.tencentcloudapi.com/?Action=ScheduleKeyDeletion
&KeyId="23e80852-1e38-11e9-b129-5cb9019b4b01"
&PendingWindowInDays=7
&<公共请求参数>

输出示例

{
  "Response": {
    "DeletionDate": 1559318399,
    "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter.InvalidPendingWindowInDays 计划删除时间参数非法。
InvalidParameterValue.InvalidKeyId KeyId不合法。
ResourceUnavailable.CmkNotFound CMK不存在。
ResourceUnavailable.CmkShouldBeDisabled 未被禁用的CMK不能被计划删除。
UnauthorizedOperation 未授权操作。