Tüm Ürünler
Search

Bu Ürün

    :ListClusters

    Belge Merkezi

    :ListClusters

    Son Güncelleme:Oct 03, 2026

    Geçerli kullanıcı için yönetilen tüm kümeleri getirir.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    sysom:ListClusters

    list

    *All Resource

    *

    		 None None

    Request syntax

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    current

    integer

    No

    Geçerli sayfa numarası (1. sayfadan başlar).

    1
    pageSize

    integer

    No

    Sayfa başına giriş sayısı.

    10
    name

    string

    No

    Eklentileri filtrelemek için kullanılan eklentinin adı.

    proxy-next-upstream
    cluster_id

    string

    No

    Kümeleri filtrelemek için kullanılan küme kimliği.

    Not

    Bu küme kimliği, ACK küme kimliği değildir. Bu işlem tarafından döndürülen id alanıdır.

    cb7d4cc26c8f845fb8a8255ffd394820e
    cluster_status

    string

    No

    • Running: Küme normal şekilde yönetilir.

    • Installing: Küme için bir kurulum görevi devam ediyor.

    • Uninstalling: Küme için bir kaldırma görevi devam ediyor.

    • Upgrading: Küme için bir güncelleme görevi devam ediyor.

    • Offline: Küme çevrimdışıdır ve yönetim durumu anormaldir.

    Running
    cluster_type

    string

    No

    • ACK: ACK kümesi.

    • CUSTOM: Özel küme. Varsayılan küme, özel küme türüne aittir.

    ACK
    id

    string

    No

    [Kullanımdan Kaldırıldı] Kümeleri filtrelemek için cluster_id parametresini kullanın.

    cb7d4cc26c8f845fb8a8255ffd394820e

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt şeması.

    RequestId

    string

    Uçtan uca tanılama için kullanılabilecek istek kimliği.

    B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
    code

    string

    Durum kodu.

    • code == Success ise yetkilendirme başarılıdır.

    • Diğer durum kodları yetkilendirmenin başarısız olduğunu gösterir. Ayrıntılı hata bilgileri için message alanını kontrol edin.

    Success
    data

    array<object>

    Döndürülen veriler.

    object

    Döndürülen veriler.

    cluster_id

    string

    Gerçek küme kimliği.

    Not

    • ACK kümeleri için bu küme kimliği, ACK küme kimliğidir.

    • CUSTOM kümeleri için bu küme kimliği benzersiz bir tanımlayıcı görevi görür ve ek bir anlamı yoktur.

    c666d4774f0e2440b979bf917bf100e40
    cluster_status

    string

    • Running: Küme normal şekilde yönetilir.

    • Installing: Küme için bir kurulum görevi devam ediyor.

    • Uninstalling: Küme için bir kaldırma görevi devam ediyor.

    • Upgrading: Küme için bir güncelleme görevi devam ediyor.

    • Offline: Küme çevrimdışıdır ve yönetim durumu anormaldir.

    Running
    cluster_type

    string

    • ACK: ACK kümesi.

    • CUSTOM: Özel küme. Varsayılan küme, özel küme türüne aittir.

    ACK
    created_at

    string

    Oluşturma zamanı.

    2024-12-25T15:08:19
    id

    string

    Küme kimliği.

    5389fba5-92a1-4ff4-9b26-773b97828144
    name

    string

    Küme adı.

    auto-name-sbvCT
    region

    string

    Bölge kimliği.

    cn-hangzhou
    updated_at

    string

    Güncelleme zamanı.

    2024-12-25T15:08:19
    message

    string

    Hata mesajı.

    • code == Success ise bu alan boştur.

    • Aksi takdirde, bu alan istek hata bilgilerini içerir.

    success
    total

    integer

    Toplam kayıt sayısı.

    64

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.