DescribeClusterNodes - Container Service for Kubernetes - Alibaba Cloud Documentation Center

Mengkueri daftar node yang memenuhi kondisi tertentu dalam sebuah kluster.

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

cs:DescribeClusterNodes

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Sintaks permintaan

GET /clusters/{ClusterId}/nodes HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	ID kluster.	c82e6987e2961451182edacd74faf****

Parameter permintaan

Parameter	Type	Required	Description	Example
instanceIds	string	No	Daftar ID instans node. Pisahkan beberapa ID dengan koma (,).	"i-bp11xjhwkj8k966u**,i-bp1dmhc2bu5igkyq**"
nodepool_id	string	No	ID kelompok node.	npe25633140a7d4fbea56cd0479c******
state	string	No	Status node kluster. Memfilter node berdasarkan status berjalan. Nilai valid: `all`: Tidak memfilter berdasarkan status berjalan. Mengkueri node dalam semua status. `running`: Node yang sedang berjalan. `removing`: Node yang sedang dihapus. `initial`: Node yang sedang diinisialisasi. `failed`: Node yang gagal dibuat. Nilai default: `all`.	running
pageSize	string	No	Jumlah maksimum catatan yang dapat ditampilkan per halaman. Nilai valid: [1,100]. Nilai default: 10.	10
pageNumber	string	No	Nomor halaman dari kueri saat ini. Nilai default: 1.	1
nodeNames	string	No		cn-hangzhou.192.168.0.1
nodeIps	string	No		192.168.0.1
nodeLabels	string	No		nodeLabels=app=nginx,env=prod

Elemen respons

Element	Type	Description	Example
	object	Badan respons.
nodes	array<object>	Daftar detail node.
	object	Detail node.
creation_time	string	Pengatur waktu saat node dibuat.	2025-04-16T07:28:00Z
error_message	string	Paket error yang dihasilkan saat node dibuat.	error***
expired_time	string	Pengatur waktu saat node kedaluwarsa.	2099-12-31T15:59:00Z
host_name	string	Hostname node.	iZ2vcckdmxp7u0urj2k****
image_id	string	ID image sistem yang digunakan oleh node.	aliyun_3_x64_20G_alibase_20241218.vhd
instance_charge_type	string	Metode penagihan node. Nilai valid: `PrePaid`: Langganan. `PostPaid`: Bayar sesuai pemakaian.	PostPaid
instance_id	string	ID instans node.	i-2vcckdmxp7u0urj2****
instance_name	string	Nama node dalam kluster.	worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****
instance_role	string	Tipe peran node. Nilai valid: Master: Node master kluster. Worker: Node pekerja kluster.	Worker
instance_status	string	Status ECS node. Nilai valid: `Pending`: Sedang dibuat. `Running`: Berjalan. `Starting`: Sedang dimulai. `Stopping`: Sedang dihentikan. `Stopped`: Dihentikan.	Running
instance_type	string	Spesifikasi node.	ecs.c5.xlarge
instance_type_family	string	Nama keluarga instans ECS tempat node berada.	ecs.c5
ip_address	array	Alamat IP node.
	string	Alamat IP.	192.168.xx.xx
is_aliyun_node	boolean	Apakah node merupakan instans Alibaba Cloud. Nilai valid: `true`: Node merupakan instans Alibaba Cloud. `false`: Node bukan instans Alibaba Cloud.	true
node_name	string	Nama node, yang merupakan pengenal node dalam kluster.	cn-chengdu.192.168xx.xx
node_status	string	Apakah node sudah siap. Nilai valid: `Ready`: Node sudah siap. `NotReady`: Node belum siap. `Unknown`: Status node tidak diketahui. `Offline`: Node sedang offline.	Ready
nodepool_id	string	ID kelompok node.	np0794239424a84eb7a95327369d56****
source	string	Metode yang digunakan untuk menginisialisasi node, seperti pembuatan manual atau pembuatan ROS.	ess
state	string	Status berjalan node. Nilai valid: `pending`: Sedang dibuat. `running`: Berjalan. `starting`: Sedang dimulai. `stopping`: Sedang dihentikan. `stopped`: Dihentikan.	running
spot_strategy	string	Tipe instans spot. Nilai valid: NoSpot: Instans non-spot. SpotWithPriceLimit: Spot instans dengan batas harga. SpotAsPriceGo: Spot instans dengan harga pasar.	NoSpot
page	object	Informasi paginasi.
page_number	integer	Nomor halaman saat ini.	1
page_size	integer	Jumlah maksimum catatan yang dapat ditampilkan per halaman.	10
total_count	integer	Jumlah total hasil.	5

Contoh

Respons sukses

JSONformat

{
  "nodes": [
    {
      "creation_time": "2025-04-16T07:28:00Z",
      "error_message": "error***",
      "expired_time": "2099-12-31T15:59:00Z",
      "host_name": "iZ2vcckdmxp7u0urj2k****",
      "image_id": "aliyun_3_x64_20G_alibase_20241218.vhd",
      "instance_charge_type": "PostPaid",
      "instance_id": "i-2vcckdmxp7u0urj2****",
      "instance_name": "worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****",
      "instance_role": "Worker",
      "instance_status": "Running",
      "instance_type": "ecs.c5.xlarge",
      "instance_type_family": "ecs.c5",
      "ip_address": [
        "192.168.xx.xx"
      ],
      "is_aliyun_node": true,
      "node_name": "cn-chengdu.192.168xx.xx",
      "node_status": "Ready",
      "nodepool_id": "np0794239424a84eb7a95327369d56****",
      "source": "ess",
      "state": "running",
      "spot_strategy": "NoSpot"
    }
  ],
  "page": {
    "page_number": 1,
    "page_size": 10,
    "total_count": 5
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.