更新密鑰的周期性自動輪轉策略。
介面說明
-
RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情，請參見存取控制。
-
開啟周期性自動輪轉後，將在上一次輪轉時間加上輪轉周期天數後，自動建立一個新的密鑰版本，並將它設定為主要版本。
-
僅預設密鑰、軟體密鑰管理執行個體中的對稱金鑰支援周期性自動輪轉。
-
預設密鑰輪轉為增值服務，需要您單獨付費購買。軟體密鑰輪轉消耗 KMS 執行個體的密鑰配額，每個密鑰版本消耗一個配額，例如密鑰有 V1、V2、V3 三個密鑰版本，則消耗 3 個密鑰配額。
-
僅由 KMS 產生密鑰材料的密鑰支援輪轉，自行匯入密鑰材料的密鑰（BYOK）不支援輪轉。
-
僅處於已啟用狀態的密鑰支援輪轉。當密鑰處於已禁用或待刪除狀態時，已開啟的輪轉功能會被停止，當密鑰重新啟用時，輪轉功能會重新啟動。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| KeyId |
string |
是 |
金鑰識別碼，即密鑰的通用唯一識別碼。 |
key-hzz62f1cb66fa42qo**** |
| EnableAutomaticRotation |
boolean |
是 |
是否開啟周期性自動輪轉。取值：
|
true |
| RotationInterval |
string |
否 |
自動輪轉的時間周期。格式為 integer[unit]，其中 integer 表示時間長度，unit 表示時間單位。合法的 unit 單位為：d（天）、h（小時）、m（分鐘）、s（秒）。7d 或者 604800s 均表示 7 天的周期。取值：
說明
當 EnableAutomaticRotation 參數為 true 時，必須設定此參數，否則無需設定。 |
30d |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。 |
efb1cbbd-a093-4278-bc03-639dd4fcc207 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "efb1cbbd-a093-4278-bc03-639dd4fcc207"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Rejected.UnsupportedOperation | Unsupported operation. | 不支援的操作 |
| 400 | InvalidParameter | The specified parameter RotationInterval is not valid. | RotationInterval 參數值無效。 |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密鑰不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。