DescribeClusterDetail - Container Service for Kubernetes

Anda dapat memanggil operasi DescribeClusterDetail untuk mengkueri detail klaster berdasarkan ID klaster.

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:DescribeClusterDetail

get

*Cluster

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

None

Sintaks permintaan

GET /clusters/{ClusterId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	ID klaster.	cdde1f21ae22e483ebcb068a6eb7f****

Parameter permintaan

Parameter

Type

Required

Description

Example

Tidak ada parameter yang diperlukan.

Elemen respons

Element	Type	Description	Example
	object	Parameter badan respons.
cluster_id	string	ID klaster.	c82e6987e2961451182edacd74faf****
cluster_type	string	Tipe klaster. `Kubernetes`: Klaster khusus ACK. `ManagedKubernetes`: Tipe klaster terkelola ACK, termasuk klaster terkelola ACK (ACK Pro dan ACK Basic), klaster ACK Serverless (Pro dan Basic), klaster ACK Edge (Pro dan Basic), dan klaster ACK Lingjun (Pro). `ExternalKubernetes`: Klaster terdaftar.	Kubernetes
created	string	Waktu pembuatan klaster.	2025-04-07T09:57:26+08:00
init_version	string	Versi awal klaster.	1.32.1-aliyun.1
current_version	string	Versi klaster saat ini. Untuk versi Kubernetes yang didukung oleh ACK, lihat Ikhtisar rilis Kubernetes.	1.32.1-aliyun.1
next_version	string	Versi klaster yang dapat ditingkatkan.	1.xx.x-aliyun.1
deletion_protection	boolean	Perlindungan penghapusan klaster, yang mencegah penghapusan klaster secara tidak sengaja melalui konsol atau API. Nilai yang valid: `true`: Mengaktifkan perlindungan penghapusan klaster. Klaster tidak dapat dihapus melalui konsol atau API. `false`: Menonaktifkan perlindungan penghapusan klaster. Klaster dapat dihapus melalui konsol atau API.	true
docker_version `deprecated`	string	Versi Docker dalam klaster.	19.03.5
external_loadbalancer_id `deprecated`	string	ID instans SLB Ingress klaster.	lb-2zehc05z3b8dwiifh****
meta_data	string	Informasi metadata klaster.	\"Addons\":***
name	string	Nama klaster.	cluster-demo
network_mode `deprecated`	string	Tipe jaringan yang digunakan oleh klaster, misalnya, VPC.	vpc
region_id	string	ID region klaster.	cn-beijing
resource_group_id	string	ID grup sumber daya klaster.	rg-acfmyvw3wjm****
security_group_id	string	ID grup keamanan klaster.	sg-25yq****
size	integer	Jumlah node klaster, termasuk node master dan node worker.	5
state	string	Status operasi klaster. Nilai yang valid: `initial`: Klaster sedang dibuat. `failed`: Klaster gagal dibuat. `running`: Klaster sedang berjalan. `updating`: Klaster sedang diperbarui. `upgrading`: Klaster sedang ditingkatkan. `removing`: Node sedang dihapus. `draining`: Node sedang dikosongkan. `scaling`: Klaster sedang diskalakan. `inactive`: Klaster tidak aktif. `unavailable`: Klaster tidak tersedia. `deleting`: Klaster sedang dihapus. `deleted`: Klaster telah dihapus. `delete_failed`: Klaster gagal dihapus. `waiting`: Klaster menunggu koneksi. `disconnected`: Klaster terputus.	running
tags	array	Tag sumber daya klaster.
	tag	Tag sumber daya klaster.
updated	string	Waktu pembaruan klaster.	2025-04-10T13:28:09+08:00
vpc_id	string	ID VPC klaster, parameter wajib saat membuat klaster.	vpc-2zecuu62b9zw7a7qn****
vswitch_id `deprecated`	string	ID vSwitch. Kolom ini tidak digunakan lagi. Untuk vSwitch control plane, gunakan kolom vswitch_ids. Untuk vSwitch data plane, kueri melalui kolom vswitch_ids dari node pool.	vsw-2zete8s4qocqg0mf6**,vsw-2zete8s4qocqg0mf6**
subnet_cidr `deprecated`	string	Blok CIDR Pod.	172.20.xx.xx/16
zone_id `deprecated`	string	ID zona ketersediaan dalam region tempat klaster berada.	cn-beijing-a
master_url	string	Endpoint akses klaster, termasuk endpoint akses internal dan publik.	{\"intranet_api_server_endpoint\":\"https://192.168.xx.xx:6443\"***}
private_zone `deprecated`	boolean	Apakah PrivateZone diaktifkan untuk klaster. `true`: Diaktifkan. `false`: Tidak diaktifkan. Nilai default: false.	false
profile	string	Subtipe klaster. `Default`: Klaster terkelola ACK, termasuk ACK Pro dan ACK Basic. `Edge`: Klaster ACK Edge, termasuk ACK Edge Pro dan ACK Edge Basic. `Serverless`: Klaster ACK Serverless, termasuk ACK Serverless Pro dan ACK Serverless Basic. `Lingjun`: Klaster ACK Lingjun, tersedia dalam edisi Pro.	Default
cluster_spec	string	Spesifikasi klaster ketika `cluster_type` diatur ke `ManagedKubernetes` dan `profile` dikonfigurasi. Nilai yang valid: `ack.standard`: Edisi Basic (dipilih secara default ketika nilai kosong) `ack.pro.small`: Edisi Pro `ack.pro.xlarge`: Pro XL `ack.pro.2xlarge`: Pro 2XL `ack.pro.4xlarge`: Pro 4XL (memerlukan menghubungi layanan pelanggan untuk mengaktifkan daftar izin) Pro XL, Pro 2XL, dan Pro 4XL adalah tiga tingkatan yang disediakan oleh ACK Pro Provisioned Control Plane. Dengan mengalokasikan dan memperkuat sumber daya control plane terlebih dahulu, mereka memastikan bahwa konkurensi API dan kemampuan penjadwalan Pod selalu berada pada tingkat tinggi yang ditentukan, cocok untuk pelatihan dan inferensi AI, klaster berskala sangat besar, dan beban kerja yang sangat penting. Untuk biaya manajemen klaster untuk edisi Pro dan edisi Provisioned Control Plane, lihat Biaya manajemen klaster.	ack.pro.small
worker_ram_role_name	string	Nama peran RAM worker, yang mengotorisasi instans ECS sebagai node worker klaster.	KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****
maintenance_window	maintenance_window	Konfigurasi jendela pemeliharaan klaster, yang hanya berlaku pada edisi terkelola (yaitu, klaster ACK Pro).
parameters `deprecated`	object	Kumpulan parameter ROS klaster.
	string	Parameter ROS.	"ALIYUN::Region": "cn-qingdao"
container_cidr	string	Blok CIDR Pod, konfigurasi jaringan Flannel.	172.20.xx.xx/16
service_cidr	string	Blok CIDR Service.	172.21.xx.xx/20
proxy_mode	string	Mode proxy kube-proxy. `iptables`: Mode proxy kube-proxy yang matang dan stabil. Penemuan layanan dan penyeimbangan beban untuk Kubernetes Services dikonfigurasi menggunakan aturan iptables. Namun, kinerjanya rata-rata dan sangat dipengaruhi oleh skala. Cocok untuk klaster dengan jumlah Service yang sedikit. `ipvs`: Mode proxy kube-proxy berkinerja tinggi. Penemuan layanan dan penyeimbangan beban untuk Kubernetes Services dikonfigurasi menggunakan modul Linux IPVS. Cocok untuk klaster dengan jumlah Service yang banyak dan skenario yang memerlukan penyeimbangan beban berkinerja tinggi.	ipvs
timezone	string	Zona waktu.	Asia/Shanghai
node_cidr_mask	string	Hanya berlaku untuk plugin jaringan Flannel. Ukuran subnet mask yang dialokasikan ke node, yang mengontrol jumlah alamat IP yang dapat dialokasikan ke suatu node.	26
ip_stack	string	Stack IP klaster. Nilai yang valid: ipv4: Membuat klaster yang hanya mendukung stack IPv4. dual: Membuat klaster yang mendukung stack ganda IPv4/IPv6.	ipv4
cluster_domain	string	Nama domain lokal klaster.	cluster.local
extra_sans	array	SAN (Subject Alternative Name) sertifikat API Server kustom.
	string	SAN sertifikat.	192.168.xx.xx
rrsa_config	object	Konfigurasi RRSA.
enabled	boolean	Apakah RRSA diaktifkan.	true
oidc_name	string	Nama penyedia identitas OIDC.	ack-rrsa-***
oidc_arn	string	ARN penyedia identitas OIDC.	acs:ram::1138*:oidc-provider/ack-rrsa-*
max_oidc_token_expiration	string	Periode kedaluwarsa maksimum yang dapat dikonfigurasi untuk Token OIDC.	12h
audience	string	Informasi audience default dari Token OIDC. Ketika mengandung beberapa nilai, nilai tersebut dipisahkan dengan koma (,). Nilai-nilai tersebut menjadi kolom aud dari Token OIDC dalam bentuk array.	https://kubernetes.default.svc,https://example.***.com
issuer	string	Informasi issuer dari Token OIDC. Ketika mengandung beberapa nilai, nilai tersebut dipisahkan dengan koma (,). Nilai pertama menjadi kolom iss dari Token OIDC dan URL issuer dari penyedia identitas OIDC.	https://oidc-ack-***,https://kubernetes.default.svc
open_api_configuration_url	string	URL dokumen konfigurasi OIDC.	https://oidc-ack-*/c12b990*/.well-known/openid-configuration
jwks_url	string	URL informasi kunci publik OIDC.	https://oidc-ack-*/c12b990*/keys
vswitch_ids	array	vSwitch control plane klaster.
	string	vSwitch control plane klaster.	vsw-2zete8s4qocqg0mf6****
operation_policy	object	Kebijakan O&M otomatis klaster.
cluster_auto_upgrade	object	Peningkatan otomatis klaster.
enabled	boolean	Specifies whether to enable auto-upgrade for the cluster.	true
channel	string	The auto-upgrade channel. For more information, see Upgrade channels. Valid values: `patch`: the latest patch version. `stable`: the second-to-last minor version. `rapid`: the latest minor version.	patch
control_plane_config	object	Konfigurasi control plane klaster khusus.
charge_type	string	Metode penagihan node control plane.	PrePaid
period	integer	Durasi langganan node.	1
period_unit	string	Unit durasi langganan node.	Month
auto_renew	boolean	Apakah perpanjangan otomatis diaktifkan untuk node.	true
auto_renew_period	integer	Durasi perpanjangan otomatis node.	1
instance_types	array	Tipe spesifikasi instans node.
	string	Spesifikasi instans.	ecs.g6.large
image_type	string	Tipe citra sistem operasi.	AliyunLinux3
image_id	string	ID Citra.	aliyun_3_x64_20G_alibase_20240819
key_pair	string	Nama key pair. Pilih salah satu antara ini atau login_password.	ack
system_disk_category	string	Tipe disk sistem node.	cloud_essd
system_disk_size	integer	Ukuran disk sistem node, minimal 40.	120
system_disk_snapshot_policy_id	string	Kebijakan pencadangan snapshot otomatis node.	sp-2zej1nogjvovnz4z****
system_disk_performance_level	string	Tingkat kinerja disk sistem node, hanya berlaku untuk disk ESSD.	PL1
system_disk_provisioned_iops	integer	IOPS baca/tulis yang disediakan untuk disk sistem node.	1000
system_disk_bursting_enabled	boolean	Apakah burst (lonjakan kinerja) diaktifkan untuk disk sistem node.	true
deploymentset_id	string	ID deployment set.	ds-bp10b35imuam5amw****
cloud_monitor_flags	boolean	Apakah akan menginstal CloudMonitor pada node.	true
soc_enabled	boolean	Apakah pengerasan keamanan terklasifikasi diaktifkan.	false
security_hardening_os	boolean	Apakah pengerasan keamanan OS Alibaba Cloud diaktifkan.	true
cpu_policy	string	Kebijakan manajemen CPU node.	none
runtime	string	Nama runtime.	containerd
node_port_range	string	Rentang port layanan node.	30000-32767
size	integer	Jumlah node control plane.	3
instance_metadata_options	InstanceMetadataOptions	Konfigurasi akses metadata instans ECS.
auto_mode	object	Konfigurasi mode terkelola cerdas.
enable	boolean	Apakah mode terkelola cerdas diaktifkan.	false
control_plane_endpoints_config	object	Konfigurasi koneksi klaster.
internal_dns_config	object	Konfigurasi nama domain internal klaster, berlaku untuk klaster terkelola ACK. Nama domain internal klaster digunakan oleh komponen sistem sisi node seperti kubelet dan kube-proxy untuk mengakses API Server. Ketika akses nama domain internal tidak diaktifkan, komponen sistem sisi node mengakses API Server melalui IP CLB.
bind_vpcs	array	The VPCs in which the internal domain name records are effective. By default, this includes the VPC where the cluster is deployed.
	string	A VPC in which the internal domain name records are effective.	vpc-xxxxxx
enabled	boolean	Specifies whether to enable access to the cluster through its internal domain name. `true`: Enables access to the cluster through its internal domain name. Node-side components, such as kubelet and kube-proxy, will use the internal domain name to access the API server.	true

Contoh

Respons sukses

JSONformat

{
  "cluster_id": "c82e6987e2961451182edacd74faf****",
  "cluster_type": "Kubernetes",
  "created": "2025-04-07T09:57:26+08:00",
  "init_version": "1.32.1-aliyun.1",
  "current_version": "1.32.1-aliyun.1",
  "next_version": "1.xx.x-aliyun.1",
  "deletion_protection": true,
  "docker_version": "19.03.5",
  "external_loadbalancer_id": "lb-2zehc05z3b8dwiifh****",
  "meta_data": "\\\"Addons\\\":***",
  "name": "cluster-demo",
  "network_mode": "vpc",
  "region_id": "cn-beijing",
  "resource_group_id": "rg-acfmyvw3wjm****",
  "security_group_id": "sg-25yq****",
  "size": 5,
  "state": "running",
  "tags": [
    {
      "key": "env",
      "value": "prod"
    }
  ],
  "updated": "2025-04-10T13:28:09+08:00",
  "vpc_id": "vpc-2zecuu62b9zw7a7qn****",
  "vswitch_id": "vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****",
  "subnet_cidr": "172.20.xx.xx/16",
  "zone_id": "cn-beijing-a",
  "master_url": "{\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.xx.xx:6443\\\"***}",
  "private_zone": false,
  "profile": "Default",
  "cluster_spec": "ack.pro.small",
  "worker_ram_role_name": "KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****",
  "maintenance_window": {
    "enable": false,
    "maintenance_time": "2020-10-15T12:31:00.000+08:00",
    "duration": "3h",
    "weekly_period": "Monday,Thursday",
    "recurrence": "FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,TU"
  },
  "parameters": {
    "key": "\"ALIYUN::Region\": \"cn-qingdao\""
  },
  "container_cidr": "172.20.xx.xx/16",
  "service_cidr": "172.21.xx.xx/20",
  "proxy_mode": "ipvs",
  "timezone": "Asia/Shanghai",
  "node_cidr_mask": "26",
  "ip_stack": "ipv4",
  "cluster_domain": "cluster.local",
  "extra_sans": [
    "192.168.xx.xx"
  ],
  "rrsa_config": {
    "enabled": true,
    "oidc_name": "ack-rrsa-***",
    "oidc_arn": "acs:ram::1138***:oidc-provider/ack-rrsa-***",
    "max_oidc_token_expiration": "12h",
    "audience": "https://kubernetes.default.svc,https://example.***.com",
    "issuer": "https://oidc-ack-***,https://kubernetes.default.svc",
    "open_api_configuration_url": "https://oidc-ack-***/c12b990***/.well-known/openid-configuration",
    "jwks_url": "https://oidc-ack-***/c12b990***/keys"
  },
  "vswitch_ids": [
    "vsw-2zete8s4qocqg0mf6****"
  ],
  "operation_policy": {
    "cluster_auto_upgrade": {
      "enabled": true,
      "channel": "patch"
    }
  },
  "control_plane_config": {
    "charge_type": "PrePaid",
    "period": 1,
    "period_unit": "Month",
    "auto_renew": true,
    "auto_renew_period": 1,
    "instance_types": [
      "ecs.g6.large"
    ],
    "image_type": "AliyunLinux3",
    "image_id": "aliyun_3_x64_20G_alibase_20240819",
    "key_pair": "ack",
    "system_disk_category": "cloud_essd",
    "system_disk_size": 120,
    "system_disk_snapshot_policy_id": "sp-2zej1nogjvovnz4z****",
    "system_disk_performance_level": "PL1",
    "system_disk_provisioned_iops": 1000,
    "system_disk_bursting_enabled": true,
    "deploymentset_id": "ds-bp10b35imuam5amw****",
    "cloud_monitor_flags": true,
    "soc_enabled": false,
    "security_hardening_os": true,
    "cpu_policy": "none",
    "runtime": "containerd",
    "node_port_range": "30000-32767",
    "size": 3,
    "instance_metadata_options": {
      "http_tokens": "optional"
    }
  },
  "auto_mode": {
    "enable": false
  },
  "control_plane_endpoints_config": {
    "internal_dns_config": {
      "bind_vpcs": [
        "vpc-xxxxxx"
      ],
      "enabled": true
    }
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.