All Products
Search

This Product

    Container Service for Kubernetes:DescribeClustersV1

    Document Center

    Container Service for Kubernetes:DescribeClustersV1

    Last Updated:Jun 12, 2026

    Anda dapat memanggil operasi DescribeClustersV1 untuk mengkueri daftar kluster ACK yang memenuhi kriteria tertentu (seperti tipe kluster dan spesifikasi kluster) di akun 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

    cs:GetClusters

    get

    *Cluster

    acs:cs:*:{#accountId}:cluster/*

    		 None None

    Sintaks permintaan

    GET /api/v1/clusters HTTP/1.1

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    name

    string

    No

    Nama kluster.

    cluster-demo
    cluster_type

    string

    No

    Tipe kluster. Nilai valid:

    • Kubernetes: Klaster khusus ACK.

    • ManagedKubernetes: Tipe kluster terkelola ACK, termasuk kluster terkelola ACK (Pro dan Basic), kluster Layanan Kontainer Serverless (Pro dan Basic), kluster Edge ACK (Pro dan Basic), dan kluster Lingjun ACK (Pro).

    • ExternalKubernetes: Kluster terdaftar.

    Kubernetes
    page_size

    integer

    No

    Jumlah rekaman per halaman.

    10
    page_number

    integer

    No

    Nomor halaman saat ini.

    1
    profile

    string

    No

    Saat Anda menetapkan cluster_type ke ManagedKubernetes (tipe kluster terkelola ACK), Anda dapat menentukan subtipe kluster lebih lanjut. Nilai valid:

    • Default: Kluster terkelola ACK, termasuk kluster ACK Pro dan kluster ACK Basic.

    • Edge: Kluster Edge ACK, termasuk kluster Edge ACK Pro dan kluster Edge ACK Basic.

    • Serverless: Kluster Layanan Kontainer Serverless, termasuk kluster Layanan Kontainer Serverless Pro dan kluster Layanan Kontainer Serverless Basic.

    • Lingjun: Kluster Lingjun ACK, tersedia dalam Pro.

    Default
    cluster_spec

    string

    No

    Spesifikasi kluster saat cluster_type ditetapkan ke ManagedKubernetes dan profile dikonfigurasi. Nilai valid:

    • ack.standard: Basic

    • ack.pro.small: Pro

    • ack.pro.xlarge: Pro XL

    • ack.pro.2xlarge: Pro 2XL

    • ack.pro.4xlarge: Pro 4XL (hubungi layanan pelanggan untuk ditambahkan ke daftar putih)

    Pro XL, Pro 2XL, dan Pro 4XL adalah tiga tingkatan yang disediakan oleh ACK Pro Provisioned Control Plane. Dengan mengalokasikan dan mendedikasikan Sumber daya lapisan kontrol sebelumnya, tingkatan ini memastikan bahwa konkurensi API dan kemampuan penjadwalan Pod tetap berada pada tingkat yang konsisten Tingkat Tinggi. Tingkatan ini cocok untuk pelatihan dan inferensi AI, kluster skala ultra-besar, dan beban kerja yang sangat penting.

    Untuk informasi mengenai biaya manajemen kluster untuk edisi Pro dan lapisan kontrol terprovisi, lihat Biaya manajemen kluster.

    ack.pro.small
    region_id

    string

    No

    Wilayah kluster. Tentukan parameter ini untuk memfilter kluster di wilayah yang ditentukan.

    cn-hangzhou
    cluster_id

    string

    No

    ID kluster.

    c3fb96524f9274b4495df0f12a6b5****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Badan respons.

    clusters

    array<object>

    Daftar informasi kluster.

    array<object>

    Instans kluster.

    cluster_id

    string

    ID kluster.

    c3fb96524f9274b4495df0f12a6b5****
    cluster_type

    string

    Tipe kluster.

    Kubernetes
    created

    string

    Pengatur waktu pembuatan kluster.

    2025-04-07T09:57:26+08:00
    init_version

    string

    Versi kluster. Untuk versi Kubernetes yang didukung oleh ACK, lihat Ikhtisar rilis versi Kubernetes.

    1.32.1-aliyun.1
    current_version

    string

    Versi kluster saat ini.

    1.32.1-aliyun.1
    next_version

    string

    Versi untuk Peningkatan kluster.

    1.xx.x-aliyun.1
    deletion_protection

    boolean

    Apakah perlindungan penghapusan diaktifkan untuk kluster. Ini mencegah penghapusan kluster secara tidak sengaja melalui konsol atau API. Nilai valid:

    • true: Perlindungan penghapusan diaktifkan. Kluster tidak dapat dihapus melalui konsol atau API.

    • false: Perlindungan penghapusan tidak diaktifkan. Kluster dapat dihapus melalui konsol atau API.

    true
    docker_version deprecated

    string

    Versi Docker kluster.

    19.03.5
    external_loadbalancer_id deprecated

    string

    ID instans Server Load Balancer (SLB) untuk Ingress kluster.

    Tipe instans default: instans kinerja terjamin (slb.s1.kecil).

    lb-2vcrbmlevo6kjpgch****
    master_url

    string

    Alamat akses server API kluster, termasuk alamat akses jaringan internal dan alamat akses jaringan publik.

    {\"api_server_endpoint\":\"\",\"intranet_api_server_endpoint\":\"https://192.168.xx.xx:6443\"}
    meta_data

    string

    Metadata kluster.

    {\"Addons\":[{\"config\":***}}
    name

    string

    Nama kluster.

    cluster-demo
    network_mode deprecated

    string

    Mode jaringan kluster. Nilai valid:

    • classic: jaringan klasik.

    • vpc: virtual private cloud (VPC).

    • overlay: jaringan overlay.

    • calico: jaringan Protokol Calico.

    vpc
    private_zone deprecated

    boolean

    Konfigurasi Private Zone kluster. Nilai valid:

    • true: Private Zone diaktifkan.

    • false: Private Zone tidak diaktifkan.

    false
    profile

    string

    Subtipe kluster.

    Default
    region_id

    string

    ID wilayah kluster.

    cn-beijing
    resource_group_id

    string

    ID kelompok sumber daya kluster.

    rg-acfmyvw3wjm****
    security_group_id

    string

    ID grup keamanan kluster.

    sg-2vcgwsrwgt5mp0yi****
    container_cidr

    string

    Blok CIDR Pod, yang merupakan konfigurasi jaringan Flannel.

    172.20.xx.xx/16
    service_cidr

    string

    Blok CIDR layanan.

    172.21.xx.xx/20
    proxy_mode

    string

    Modus proxy kube-proxy. Nilai valid:

    • iptables: modus proxy kube-proxy yang matang dan stabil. Penemuan layanan dan penyeimbangan beban untuk Layanan Kubernetes dikonfigurasi menggunakan aturan iptables. Kinerja moderat dan dipengaruhi oleh skala kluster. Mode ini cocok untuk kluster dengan jumlah Layanan yang kecil.

    • ipvs: modus proxy kube-proxy berkinerja tinggi. Penemuan layanan dan penyeimbangan beban untuk Layanan Kubernetes dikonfigurasi menggunakan modul IPVS Linux. Mode ini cocok untuk kluster dengan jumlah Layanan Tingkat Tinggi yang memerlukan kinerja penyeimbangan beban tinggi.

    ipvs
    timezone

    string

    Zona pengatur waktu.

    Asia/Shanghai
    ip_stack

    string

    Tumpukan protokol IP kluster. Nilai valid:

    • ipv4: membuat kluster yang hanya mendukung tumpukan protokol IPv4.

    • dual: membuat kluster yang mendukung tumpukan ganda IPv4/IPv6.

    ipv4
    cluster_domain

    string

    Nama domain lokal kluster.

    cluster.local
    size

    integer

    Jumlah node saat ini di kluster, termasuk node master dan node worker.

    5
    state

    string

    Status berjalan kluster. Nilai valid:

    • initial: Kluster sedang dibuat.

    • failed: Kluster gagal dibuat.

    • running: Kluster sedang berjalan.

    • updating: Kluster sedang diperbarui.

    • upgrading: Kluster sedang dalam Peningkatan.

    • removing: Node sedang dihapus.

    • draining: Node sedang dikosongkan.

    • scaling: Kluster sedang diskalakan.

    • inactive: Kluster tidak aktif.

    • unavailable: Kluster tidak tersedia.

    • deleting: Kluster sedang dihapus.

    • deleted: Kluster telah dihapus.

    • delete_failed: Kluster gagal dihapus.

    • waiting: Kluster berada dalam status diakses, menunggu untuk dihubungkan.

    • disconnected: Kluster terputus.

    running
    subnet_cidr deprecated

    string

    [Bidang ini tidak digunakan lagi] Gunakan container_cidr untuk mendapatkan blok CIDR Pod.

    null
    tags

    array

    Tag sumber daya kluster.

    tag

    Tag sumber daya kluster.

    updated

    string

    Pengatur waktu pembaruan terakhir kluster.

    2025-04-07T09:57:26+08:00
    vpc_id

    string

    ID VPC kluster.

    vpc-2vcg932hsxsxuqbgl****
    vswitch_id deprecated

    string

    ID vSwitch kluster.

    vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****
    vswitch_ids

    array

    vSwitch lapisan kontrol kluster.

    string

    vSwitch lapisan kontrol kluster.

    vsw-2vc41xuumx5z2rdma****
    worker_ram_role_name deprecated

    string

    Nama peran RAM worker yang mengotorisasi instans ECS untuk berfungsi sebagai node worker kluster.

    KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****
    zone_id deprecated

    string

    ID zona kluster.

    cn-beijing-b
    cluster_spec

    string

    Spesifikasi kluster.

    ack.standard
    maintenance_window maintenance_window

    Jendela pemeliharaan kluster. Fitur ini hanya berlaku untuk kluster terkelola ACK dan kluster Layanan Kontainer Serverless.

    operation_policy

    object

    Kebijakan O&M otomatis kluster.

    cluster_auto_upgrade

    object

    The configurations of auto cluster update.

    enabled

    boolean

    Specifies whether to enable auto cluster update.

    true
    channel

    string

    The frequency of auto cluster updates. For more information, see Update frequency.

    Valid values:

    • patch: the latest patch version.

    • stables: the second-latest minor version.

    • rapid: the latest minor version.

    patch
    page_info

    object

    Informasi paginasi.

    page_number

    integer

    Nomor halaman.

    3
    page_size

    integer

    Ukuran halaman.

    20
    total_count

    integer

    Jumlah total hasil.

    50

    Contoh

    Respons sukses

    JSONformat

    {
  "clusters": [
    {
      "cluster_id": "c3fb96524f9274b4495df0f12a6b5****",
      "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-2vcrbmlevo6kjpgch****",
      "master_url": "{\\\"api_server_endpoint\\\":\\\"\\\",\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.xx.xx:6443\\\"}",
      "meta_data": "{\\\"Addons\\\":[{\\\"config\\\":***}}",
      "name": "cluster-demo",
      "network_mode": "vpc",
      "private_zone": false,
      "profile": "Default",
      "region_id": "cn-beijing",
      "resource_group_id": "rg-acfmyvw3wjm****",
      "security_group_id": "sg-2vcgwsrwgt5mp0yi****",
      "container_cidr": "172.20.xx.xx/16",
      "service_cidr": "172.21.xx.xx/20",
      "proxy_mode": "ipvs",
      "timezone": "Asia/Shanghai",
      "ip_stack": "ipv4",
      "cluster_domain": "cluster.local",
      "size": 5,
      "state": "running",
      "subnet_cidr": "null",
      "tags": [
        {
          "key": "env",
          "value": "prod"
        }
      ],
      "updated": "2025-04-07T09:57:26+08:00",
      "vpc_id": "vpc-2vcg932hsxsxuqbgl****",
      "vswitch_id": "vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****",
      "vswitch_ids": [
        "vsw-2vc41xuumx5z2rdma****"
      ],
      "worker_ram_role_name": "KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****",
      "zone_id": "cn-beijing-b",
      "cluster_spec": "ack.standard",
      "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"
      },
      "operation_policy": {
        "cluster_auto_upgrade": {
          "enabled": true,
          "channel": "patch"
        }
      }
    }
  ],
  "page_info": {
    "page_number": 3,
    "page_size": 20,
    "total_count": 50
  }
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.