更新密钥的周期性自动轮转策略。
接口说明
-
RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。
-
开启周期性自动轮转后，将在上一次轮转时间加上轮转周期天数后，自动创建一个新的密钥版本，并将它设置为主版本。
-
仅默认密钥、软件密钥管理实例中的对称密钥支持周期性自动轮转。
-
默认密钥轮转为增值服务，需要您单独付费购买。软件密钥轮转消耗 KMS 实例的密钥配额，每个密钥版本消耗一个配额，例如密钥有 V1、V2、V3 三个密钥版本，则消耗 3 个密钥配额。
-
仅由 KMS 生成密钥材料的密钥支持轮转，自行导入密钥材料的密钥（BYOK）不支持轮转。
-
仅处于已启用状态的密钥支持轮转。当密钥处于已禁用或待删除状态时，已开启的轮转功能会被停止，当密钥重新启用时，轮转功能会重新启动。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| KeyId | string | 是 | 密钥 ID，即密钥的全局唯一标识符。 | key-hzz62f1cb66fa42qo**** |
| EnableAutomaticRotation | boolean | 是 | 是否开启周期性自动轮转。取值：
| true |
| RotationInterval | string | 否 | 自动轮转的时间周期。格式为 integer[unit]，其中 integer 表示时间长度，unit 表示时间单位。合法的 unit 单位为：d（天）、h（小时）、m（分钟）、s（秒）。7d 或者 604800s 均表示 7 天的周期。取值：
说明
当 EnableAutomaticRotation 参数为 true 时，必须设置此参数，否则无需设置。
| 30d |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "efb1cbbd-a093-4278-bc03-639dd4fcc207"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Rejected.UnsupportedOperation | Unsupported operation. | 不支持的操作 |
| 400 | InvalidParameter | The specified parameter RotationInterval is not valid. | RotationInterval 参数值无效。 |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密钥不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-12-20 | OpenAPI 错误码发生变更 | 查看变更详情 |