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

操作説明

kubeconfig ファイルに対して発行される証明書のデフォルトの有効期間は 3 年です。有効期間の満了前 180 日以内であれば、Container サービス for Kubernetes コンソール、またはクラスターの kubeconfig を取得する API オペレーションを呼び出すことで、証明書がローテーションされた更新済みの kubeconfig ファイルを取得できます。新しい kubeconfig 証明書は引き続き 3 年間有効です。古い kubeconfig 認証情報は、証明書の有効期間が満了するまで有効です。コンソールに表示される、または API オペレーションによって返される kubeconfig の有効期限の時間に基づいて、ローテーションされた認証情報を速やかに取得してください。
クラスター管理用の kubeconfig 認証情報を適切に管理し、不要になった場合は速やかに取り消すことで、kubeconfig の露出によるデータ漏洩などのセキュリティリスクを防止してください。

今すぐお試しください

この 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:DescribeClusterUserKubeconfig

get

*クラスター。

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

cs:KubeConfigDurationMinutes

なし

リクエスト構文

GET /k8s/{ClusterId}/user_config HTTP/1.1

パスパラメーター

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PrivateIpAddress	boolean	任意	内部ネットワークの接続設定を取得するかどうかを指定します。有効な値: true: 内部ネットワークの接続認証情報のみを取得します。 false: パブリックネットワークの接続認証情報のみを取得します。デフォルト値: false。	false
TemporaryDurationMinutes	integer	任意	一時的な kubeconfig ファイルの有効期間 (分単位)。有効な値: 15 ~ 4320。説明このパラメーターを指定しない場合、システムは自動的に長い有効期間を決定します。応答の expiration フィールドの値に基づいて、具体的な有効期限の時間を判断できます。	15

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
config	string	クラスターの kubeconfig ファイル。	apiVersion: v1\nclusters:\n- cluster:\n server: https://114.55.xx.xx:6443\n certificate-authority-data: LS0tLS****
expiration	string	kubeconfig ファイルの有効期限。時間は協定世界時 (UTC) で表示され、RFC 3339 標準に準拠します。	2024-03-10T09:56:17Z

例

成功レスポンス

JSONJSON

{
  "config": "apiVersion: v1\\nclusters:\\n- cluster:\\n    server: https://114.55.xx.xx:6443\\n    certificate-authority-data: LS0tLS****",
  "expiration": "2024-03-10T09:56:17Z"
}

エラーコード

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

変更履歴

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