调用UpdateRotationPolicy接口更新密钥轮转策略。

使用说明

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

以下密钥不允许配置自动轮转策略:

  • 非对称密钥
  • 服务密钥
  • 用户自带密钥(外部导入到KMS的密钥)
  • 不处于Enabled状态的密钥

本文将提供一个示例,为密钥ID为1234abcd-12ab-34cd-56ef-12345678****的用户主密钥开启自动轮转,自动轮转的时间周期为30天。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateRotationPolicy

要执行的操作。取值:UpdateRotationPolicy。

EnableAutomaticRotation Boolean true

是否开启自动轮转。取值:

  • true:开启。
  • false:关闭。
KeyId String 1234abcd-12ab-34cd-56ef-12345678****

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

RotationInterval String 30d

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

说明 当EnableAutomaticRotation参数为true时,必须设置此参数;否则,将忽略此参数。

返回数据

名称 类型 示例值 描述
RequestId String efb1cbbd-a093-4278-bc03-639dd4fcc207

请求ID。

示例

请求示例

https://[Endpoint]/?Action=UpdateRotationPolicy
&EnableAutomaticRotation=true
&KeyId=1234abcd-12ab-34cd-56ef-12345678****
&RotationInterval=30d
&<公共请求参数>

正常返回示例

XML格式

<KMS>
    <RequestId>efb1cbbd-a093-4278-bc03-639dd4fcc207</RequestId>
</KMS>

JSON格式

{
    "RequestId": "efb1cbbd-a093-4278-bc03-639dd4fcc207"
}

错误码

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