更新密钥轮转策略。

如果开启自动轮转,将在上一次轮转时间加上轮转周期天数后,自动创建一个新的密钥版本,并将它设置为主版本。下列情况不允许配置自动轮转策略:

  • 指定的主密钥为非对称密钥。
  • 指定的主密钥为云产品托管的默认密钥。
  • 指定的主密钥为用户自带密钥(外部导入到KMS的密钥)。
  • 指定的主密钥处于Enabled之外的状态。

调试

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

请求参数

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

系统规定参数。取值:UpdateRotationPolicy。

EnableAutomaticRotation Boolean true

是否开启自动密钥轮转。取值:true | false。

KeyId String 1234abcd-12ab-34cd-56ef-12345678****

主密钥的全局唯一标识符。

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"
}

错误码

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