ListClusters - Alibaba Cloud Linux - Alibaba Cloud ドキュメントセンター

現在のユーザーのすべてのマネージドクラスターを取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sysom:ListClusters

list

*すべてのリソース。

*

なし

リクエスト構文

GET /api/v1/am/cluster/list_clusters HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
current	integer	任意	現在のページ番号 (1 から始まります)。	1
pageSize	integer	任意	1 ページあたりのエントリ数。	10
name	string	任意	プラグインのフィルターに使用されるプラグイン名。	proxy-next-upstream
cluster_id	string	任意	クラスターのフィルターに使用されるクラスター ID。説明このクラスター ID は ACK クラスター ID ではありません。この操作によって返される id フィールドです。	cb7d4cc26c8f845fb8a8255ffd394820e
cluster_status	string	任意	Running: クラスターは正常に管理されています。 Installing: クラスターのインストールタスクが進行中です。 Uninstalling: クラスターのアンインストールタスクが進行中です。 Upgrading: クラスターの更新タスクが進行中です。 Offline: クラスターはオフラインであり、管理が異常です。	Running
cluster_type	string	任意	ACK: ACK クラスター。 CUSTOM: カスタムクラスター。デフォルトのクラスターはカスタムクラスタータイプに属します。	ACK
id	string	任意	[非推奨] クラスターのフィルターには cluster_id パラメーターを使用します。	cb7d4cc26c8f845fb8a8255ffd394820e

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。エンドツーエンドの診断に使用できます。	B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
code	string	状態コード。コード == Success の場合、権限付与は成功です。その他の状態コードは、権限付与が失敗したことを示します。詳細なエラー情報については、メッセージフィールドを確認してください。	Success
data	array<object>	返されるデータ。
	object	返されるデータ。
cluster_id	string	実際のクラスター ID。説明 ACK クラスターの場合、このクラスター ID は ACK クラスター ID です。 CUSTOM クラスターの場合、このクラスター ID は一意の識別子として機能し、追加の意味はありません。	c666d4774f0e2440b979bf917bf100e40
cluster_status	string	Running: クラスターは正常に管理されています。 Installing: クラスターのインストールタスクが進行中です。 Uninstalling: クラスターのアンインストールタスクが進行中です。 Upgrading: クラスターの更新タスクが進行中です。 Offline: クラスターはオフラインであり、管理が異常です。	Running
cluster_type	string	ACK: ACK クラスター。 CUSTOM: カスタムクラスター。デフォルトのクラスターはカスタムクラスタータイプに属します。	ACK
created_at	string	作成時間。	2024-12-25T15:08:19
id	string	クラスター ID。	5389fba5-92a1-4ff4-9b26-773b97828144
name	string	クラスター名。	auto-name-sbvCT
region	string	リージョン ID。	cn-hangzhou
updated_at	string	更新時間。	2024-12-25T15:08:19
message	string	エラーメッセージ。コード == Success の場合、このフィールドは空です。それ以外の場合、このフィールドにはリクエストのエラー情報が含まれます。	success
total	integer	レコードの総数。	64

例

成功レスポンス

JSONJSON

{
  "RequestId": "B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7",
  "code": "Success",
  "data": [
    {
      "cluster_id": "c666d4774f0e2440b979bf917bf100e40",
      "cluster_status": "Running",
      "cluster_type": "ACK",
      "created_at": "2024-12-25T15:08:19",
      "id": "5389fba5-92a1-4ff4-9b26-773b97828144",
      "name": "auto-name-sbvCT",
      "region": "cn-hangzhou",
      "updated_at": "2024-12-25T15:08:19"
    }
  ],
  "message": "success",
  "total": 64
}

エラーコード

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

変更履歴

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