根據叢集 ID,更新指定叢集的 Secret 落盤加密功能配置。
介面說明
開啟或關閉落盤加密功能的過程中以及成功開啟該功能後,請勿使用 KMS 控制台或 OpenAPI 禁用或刪除該功能所使用的 KMS 密鑰,否則會導致叢集 API Server 不可用,繼而無法正常擷取 Secret 和 ServiceAccount 等對象,影響業務應用的正常運行。更多資訊,請參見使用阿里雲 KMS 進行 Secret 的落盤加密。
調用該 API 的使用者或角色需要額外被授予所需的叢集 RBAC 許可權(需要被授予營運人員或管理員權限),否則將返回“ForbiddenUpdateKMSState”錯誤碼。
成功調用該 API 後,叢集狀態將被變更為“更新中”,待變更完成後叢集狀態將恢複為“運行中”。針對同一個叢集的變更完成後,需要間隔 5 分鐘以上才能再次調用該 API,否則將返回“409”狀態代碼。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cs:UpdateKMSEncryption |
none |
*Cluster
|
無 | 無 |
請求文法
PUT /clusters/{ClusterId}/kms HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ClusterId |
string |
是 |
叢集 ID。 |
c4fe1e3a721544*** |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| body |
object |
否 |
請求體參數。 |
|
| kms_key_id |
string |
否 |
Secret 落盤加密功能使用的 KMS 金鑰識別碼。 重要 不能使用服務密鑰,只能使用主要金鑰或者使用者主要金鑰。該密鑰的密鑰類型必須是 Aliyun_AES_256,密鑰用途必須是 ENCRYPT/DECRYPT。
警告 開啟或關閉落盤加密功能的過程中以及成功開啟該功能後,請勿使用 KMS 控制台或 OpenAPI 禁用或刪除該 KMS 密鑰,否則會導致叢集 API Server 不可用,繼而無法正常擷取 Secret 和 ServiceAccount 等對象,影響業務應用的正常運行。 |
key-abc*** |
| disable_encryption |
boolean |
否 |
是否禁用 Secret 落盤加密功能。
|
false |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
當前API暫無返回參數
樣本
正常返回樣本
JSON格式
{}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。