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

ListUserKubeConfigStates 操作を呼び出して、現在のユーザーが管理するすべてのクラスターの kubeconfig ファイルのステータスを照会できます。

操作説明

説明

この操作を呼び出すには、AliyunCSFullAccess 権限が必要です。

今すぐお試しください

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

none

*All Resource

*

なし

リクエスト構文

GET /users/{Uid}/kubeconfig/states HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
Uid	string	任意	Alibaba Cloud アカウント内の指定された Resource Access Management (RAM) ユーザーまたは RAM ロールの ID。	206945240368******

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
page_number	integer	任意	ページ番号。有効値：≥ 1。デフォルト値：1。	2
page_size	integer	任意	1 ページあたりのエントリ数。有効値：1～100。デフォルト値：50。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディパラメーター。
states	array<object>	kubeconfig ファイルのステータス。
	object
cluster_id	string	クラスター ID。	c5b5e80b0b64a4bf6939d2d8fbbc5****
cert_expire_time	string	kubeconfig ファイルで使用される証明書の有効期限。フォーマット：RFC3339 フォーマットの協定世界時 (UTC)。	2028-04-09T06:20:47Z
cert_state	string	kubeconfig ファイルで使用される証明書の現在のステータス。有効値： Expired：証明書は期限切れです。 Unexpired：証明書は有効期限内です。 Unissued：証明書は発行されていません。 Unknown：証明書のステータスは不明です。 Removed：証明書は削除されています。証明書の発行レコードが見つかりました。	Unissued
cluster_state	string	クラスターのステータス。有効値： `initial`：クラスターは作成中です。 `failed`：クラスターの作成に失敗しました。 `running`：クラスターは実行中です。 `updating`：クラスターはアップグレード中です。 `updating_failed`：クラスターの更新に失敗しました。 `scaling`：クラスターはスケーリング中です。 `stopped`：クラスターは停止しています。 `deleting`：クラスターは削除中です。 `deleted`：クラスターは削除されました。 `delete_failed`：クラスターの削除に失敗しました。	running
cluster_name	string	クラスター名。名前は 1～63 文字で、数字、アンダースコア (_)、ハイフン (-) を使用できます。名前は文字または数字で始まる必要があります。	cluster-demo
page	object	ページネーション情報。
page_number	integer	返されたページのページ番号。	1
page_size	integer	1 ページあたりのエントリ数。	10
total_count	integer	返されたエントリの総数。	100

例

成功レスポンス

JSONJSON

{
  "states": [
    {
      "cluster_id": "c5b5e80b0b64a4bf6939d2d8fbbc5****\n",
      "cert_expire_time": "2028-04-09T06:20:47Z",
      "cert_state": "Unissued",
      "cluster_state": "running",
      "cluster_name": "cluster-demo"
    }
  ],
  "page": {
    "page_number": 1,
    "page_size": 10,
    "total_count": 100
  }
}

エラーコード

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

変更履歴

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