更新密鑰的自動輪轉策略。
開啟自動輪轉后，將在上一次輪轉時間加上輪轉周期天數后，自動創建一個新的密鑰版本，并將它設置為主版本。
使用限制：
- 僅軟件密鑰管理實例中的對稱密鑰支持輪轉。
- 僅處于已啟用狀態的密鑰支持輪轉。當密鑰處于禁用或待刪除狀態時，已開啟的輪轉功能會被停止，當密鑰重新啟用時，輪轉功能會重新啟動。
- 密鑰的每個密鑰版本消耗一個密鑰配額。例如密鑰有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. | 指定的密鑰不存在。 |
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助？