ListClusters - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Mengambil semua kluster terkelola untuk pengguna saat ini.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

sysom:ListClusters

list

*Semua sumber daya.

*

None

Sintaks permintaan

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

Parameter permintaan

Parameter	Type	Required	Description	Example
current	integer	No	Nomor halaman saat ini (dimulai dari halaman 1).	1
pageSize	integer	No	Jumlah entri per halaman.	10
name	string	No	Nama plug-in yang digunakan untuk memfilter plug-in.	proxy-next-upstream
cluster_id	string	No	ID kluster yang digunakan untuk memfilter kluster. Catatan ID kluster ini bukan ID kluster ACK. Ini adalah bidang `id` yang dikembalikan oleh operasi ini.	cb7d4cc26c8f845fb8a8255ffd394820e
cluster_status	string	No	`Running`: Kluster dikelola secara normal. `Installing`: Tugas instalasi sedang berlangsung untuk kluster. `Uninstalling`: Tugas pencopotan instalasi sedang berlangsung untuk kluster. `Upgrading`: Tugas pembaruan sedang berlangsung untuk kluster. `Offline`: Kluster offline dan pengelolaan tidak normal.	Running
cluster_type	string	No	`ACK`: Kluster ACK. `CUSTOM`: Kluster kustom. Kluster default termasuk dalam tipe kluster kustom.	ACK
id	string	No	[Tidak digunakan lagi] Gunakan parameter cluster_id untuk memfilter kluster.	cb7d4cc26c8f845fb8a8255ffd394820e

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
RequestId	string	ID permintaan, yang dapat digunakan untuk diagnostik end-to-end.	B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
code	string	Kode status. Jika `code == Success`, otorisasi berhasil. Kode status lain menunjukkan otorisasi gagal. Periksa bidang `Paket` untuk informasi kesalahan mendetail.	Success
data	array<object>	Data yang dikembalikan.
	object	Data yang dikembalikan.
cluster_id	string	ID kluster aktual. Catatan Untuk kluster `ACK`, ID kluster ini adalah ID kluster ACK. Untuk kluster `CUSTOM`, ID kluster ini berfungsi sebagai pengidentifikasi unik dan tidak memiliki makna tambahan.	c666d4774f0e2440b979bf917bf100e40
cluster_status	string	`Running`: Kluster dikelola secara normal. `Installing`: Tugas instalasi sedang berlangsung untuk kluster. `Uninstalling`: Tugas pencopotan instalasi sedang berlangsung untuk kluster. `Upgrading`: Tugas pembaruan sedang berlangsung untuk kluster. `Offline`: Kluster offline dan pengelolaan tidak normal.	Running
cluster_type	string	`ACK`: Kluster ACK. `CUSTOM`: Kluster kustom. Kluster default termasuk dalam tipe kluster kustom.	ACK
created_at	string	Pengatur waktu pembuatan.	2024-12-25T15:08:19
id	string	ID kluster.	5389fba5-92a1-4ff4-9b26-773b97828144
name	string	Nama kluster.	auto-name-sbvCT
region	string	ID wilayah.	cn-hangzhou
updated_at	string	Pengatur waktu pembaruan.	2024-12-25T15:08:19
message	string	Paket kesalahan. Jika `code == Success`, bidang ini kosong. Jika tidak, bidang ini berisi informasi kesalahan permintaan.	success
total	integer	Jumlah total rekaman.	64

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.