全部產品
Search

搜尋本產品

    Alibaba Cloud Linux：ListClusters

    文件中心

    Alibaba Cloud Linux：ListClusters

    更新時間：Sep 11, 2026

    取得目前使用者所有已納管的叢集。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    sysom:ListClusters

    list

    *全部資源。

    *

    		 無 無

    請求文法

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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    current

    integer

    否

    目前頁數（從第 1 頁開始）。

    1
    pageSize

    integer

    否

    每頁大小。

    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

    Schema of Response

    RequestId

    string

    請求 ID，可用於全鏈路診斷。

    B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
    code

    string

    狀態碼

    • code == Success 則代表授權成功；

    • 其他狀態碼代表授權失敗，授權失敗時檢視 message 欄位取得詳細的錯誤資訊。

    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

    錯誤資訊

    • 如果 code == Success，則本欄位為空；

    • 否則本欄位包含請求錯誤資訊。

    success
    total

    integer

    總記錄數。

    64

    樣本

    正常返回樣本

    JSON格式

    {
  "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
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。