UpdateKMSEncryption - Container Service for Kubernetes - Alibaba Cloud ドキュメントセンター

操作説明

保存時暗号化機能を有効化または無効化する過程、および有効化が完了した後、Key Management Service (KMS) コンソールまたは OpenAPI を介してこの機能で使用される KMS キーを無効化または削除しないでください。これを実行すると、クラスターの API Server が利用不可になり、Secret や ServiceAccount などのオブジェクトが正常に取得できなくなるため、ビジネスアプリケーションの通常運用に支障をきたします。詳細については、「Alibaba Cloud KMS を使用した Secret の保存時暗号化」をご参照ください。
この API を呼び出すユーザーまたはロールには、必要なクラスターの RBAC 権限 (運用担当者または管理者権限) を追加で付与する必要があります。そうしないと、「ForbiddenUpdateKMSState」エラーコードが返されます。
この API の呼び出しが成功すると、クラスターの状態は「更新中」に変わります。変更が完了すると、クラスターの状態は「実行中」に戻ります。同じクラスターに対する変更が完了してから、再度この API を呼び出すには 5 分以上の間隔をあける必要があります。そうしないと、「409」ステータスコードが返されます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cs:UpdateKMSEncryption

none

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

なし

リクエスト構文

PUT /clusters/{ClusterId}/kms HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クラスター ID。	c4fe1e3a721544***

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディパラメーター。
kms_key_id	string	任意	Secret の保存時暗号化機能で使用される KMS キー ID。重要サービスキーは使用できません。マスターキーまたはカスタマーマスターキーを使用する必要があります。キータイプは `Aliyun_AES_256`、キーの用途は `ENCRYPT/DECRYPT` である必要があります。警告保存時暗号化機能を有効化または無効化する過程、および有効化が完了した後、KMS コンソールまたは OpenAPI を介して KMS キーを無効化または削除しないでください。これを実行すると、クラスターの API Server が利用不可になり、Secret や ServiceAccount などのオブジェクトが正常に取得できなくなるため、ビジネスアプリケーションの通常運用に支障をきたします。	key-abc***
disable_encryption	boolean	任意	Secret の保存時暗号化機能を無効にするかどうかを指定します。 `true`：保存時暗号化機能を無効にします。 `false`：保存時暗号化機能を有効にします。	false

レスポンスフィールド

フィールド

型

説明

例

レスポンスフィールドがありません。

例

成功レスポンス

JSONJSON

{}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。