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

kubeconfig ファイルには、クライアントが Container Service for Kubernetes (ACK) クラスターにアクセスするために使用する ID と認証情報が保存されます。kubectl クライアントを使用して ACK クラスターを管理するには、対応する kubeconfig ファイルを使用して ACK クラスターに接続する必要があります。kubeconfig ファイルの漏えいによるデータ漏えいを防ぐため、kubeconfig ファイルは機密情報として扱い、利用中でない kubeconfig ファイルは取り消すことを推奨します。

操作説明

kubeconfig ファイルのデフォルトの有効期間は 3 年です。kubeconfig ファイルの有効期限が切れる 180 日前から、Container Service for Kubernetes (ACK) コンソールまたは API オペレーションを呼び出すことで更新できます。kubeconfig ファイルを更新すると、その有効期間は 3 年間になります。以前の kubeconfig ファイルは、有効期限が切れるまで引き続き有効です。kubeconfig ファイルは、できるだけ早く更新することを推奨します。
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

*Cluster

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

cs:KubeConfigDurationMinutes

なし

リクエスト構文

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

パスパラメーター

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PrivateIpAddress	boolean	任意	内部ネットワーク経由でクラスターに接続するための kubeconfig ファイルを取得するかどうかを指定します。 `true`：マスターインスタンスに内部ネットワーク経由で接続するための kubeconfig ファイルを取得します。 `false`：マスターインスタンスにインターネット経由で接続するための kubeconfig ファイルを取得します。デフォルト値：`false`	false
TemporaryDurationMinutes	integer	任意	一時的な kubeconfig ファイルの有効期間。単位：分。有効な値の範囲：15～4320 (3 日間)。注意事項** このパラメーターを指定しない場合、システムはより長い有効期間を指定します。有効期間は `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 ファイルの有効期限。フォーマット：RFC3339 フォーマットの協定世界時 (UTC)。	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"
}

エラーコード

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

変更履歴

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