更新密钥的自动轮转策略。
开启自动轮转后,将在上一次轮转时间加上轮转周期天数后,自动创建一个新的密钥版本,并将它设置为主版本。
使用限制:
- 仅软件密钥管理实例中的对称密钥支持轮转。
- 仅处于已启用状态的密钥支持轮转。当密钥处于禁用或待删除状态时,已开启的轮转功能会被停止,当密钥重新启用时,轮转功能会重新启动。
- 密钥的每个密钥版本消耗一个密钥配额。例如密钥有V1、V2、V3三个密钥版本,则该密钥消耗3个密钥配额。
本文将提供一个示例,为密钥ID为key-hzz62f1cb66fa42qo****
的密钥开启自动轮转,自动轮转的时间周期为30天。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | UpdateRotationPolicy | 要执行的操作。取值:UpdateRotationPolicy。 |
KeyId | String | 是 | key-hzz62f1cb66fa42qo**** | 密钥ID,即密钥的全局唯一标识符。 |
EnableAutomaticRotation | Boolean | 是 | true | 是否开启自动轮转。取值:
|
RotationInterval | String | 否 | 30d | 自动轮转的时间周期。格式为integer[unit],其中integer表示时间长度,unit表示时间单位。合法的unit单位为:d(天)、h(小时)、m(分钟)、s(秒)。7d或者604800s均表示7天的周期。取值范围:7~365天。 说明
当EnableAutomaticRotation参数为true时,必须设置此参数,否则无需设置。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | efb1cbbd-a093-4278-bc03-639dd4fcc207 | 本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
示例
请求示例
http(s)://[Endpoint]/?Action=UpdateRotationPolicy
&KeyId=key-hzz62f1cb66fa42qo****
&EnableAutomaticRotation=true
&RotationInterval=30d
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateRotationPolicyResponse>
<RequestId>efb1cbbd-a093-4278-bc03-639dd4fcc207</RequestId>
</UpdateRotationPolicyResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "efb1cbbd-a093-4278-bc03-639dd4fcc207"
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InvalidParameter | The specified parameter is not valid. | 参数非法。 |
404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. | 提供的 Access Key ID不存在 |
404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密钥不存在。 |
访问错误中心查看更多错误码。