UpdateRotationPolicy_密钥管理服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

开启周期性自动轮转后,将在上一次轮转时间加上轮转周期天数后,自动创建一个新的密钥版本,并将它设置为主版本。

  • 仅默认密钥、软件密钥管理实例中的对称密钥支持周期性自动轮转。

  • 默认密钥轮转为增值服务,需要您单独付费购买。软件密钥轮转消耗 KMS 实例的密钥配额,每个密钥版本消耗一个配额,例如密钥有 V1、V2、V3 三个密钥版本,则消耗 3 个密钥配额。

  • 仅由 KMS 生成密钥材料的密钥支持轮转,自行导入密钥材料的密钥(BYOK)不支持轮转。

  • 仅处于已启用状态的密钥支持轮转。当密钥处于已禁用或待删除状态时,已开启的轮转功能会被停止,当密钥重新启用时,轮转功能会重新启动。

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
KeyIdstring

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

示例值:key-hzz62f1cb66fa42qo****参考取值来源:
    ListKeys
    CreateKey
EnableAutomaticRotationboolean

是否开启周期性自动轮转。取值:展开详情

示例值:true
RotationIntervalstring

自动轮转的时间周期。格式为 integer[unit],其中 integer 表示时间长度,unit 表示时间单位。合法的 unit 单位为:d(天)、h(小时)、m(分钟)、s(秒)。7d 或者 604800s 均表示 7 天的周期。取值:展开详情

示例值:30d

返回参数

字段名称字段详情
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

示例值:efb1cbbd-a093-4278-bc03-639dd4fcc207

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
Rejected.UnsupportedOperation
Unsupported operation.诊断
400
InvalidParameter
The specified parameter RotationInterval is not valid.诊断
404
Forbidden.KeyNotFound
The specified Key is not found.诊断

变更历史

变更时间变更内容概要操作
2023-12-20
变更错误码400
变更错误码404
2022-09-22
新增错误码400
新增错误码404

相关示例

通过调用 UpdateRotationPolicy 接口更新密钥轮转策略示例
2023-03-29