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 klaster ACK yang memenuhi kriteria kondisional (seperti jenis klaster dan spesifikasi klaster) di bawah 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 klaster.

    cluster-demo
    cluster_type

    string

    No

    Jenis klaster. Nilai yang valid:

    • Kubernetes: Klaster khusus ACK.

    • ManagedKubernetes: Klaster terkelola ACK, termasuk klaster terkelola ACK (Pro dan Basic), klaster ACK Serverless (Pro dan Basic), klaster ACK Edge (Pro dan Basic), dan klaster ACK Lingjun (Pro).

    • ExternalKubernetes: klaster terdaftar.

    Kubernetes
    page_size

    integer

    No

    Jumlah rekaman per halaman.

    10
    page_number

    integer

    No

    Nomor halaman saat ini.

    1
    profile

    string

    No

    Ketika Anda mengatur cluster_type ke ManagedKubernetes (klaster terkelola ACK), Anda dapat menentukan lebih lanjut subjenis klaster. Nilai yang valid:

    • 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 Pro.

    Default
    cluster_spec

    string

    No

    Spesifikasi klaster ketika cluster_type diatur ke ManagedKubernetes dan profile dikonfigurasi. Nilai yang 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 bidang kontrol terlebih dahulu, tingkatan ini memastikan bahwa konkurensi API dan kemampuan penjadwalan Pod tetap pada tingkat yang konsisten tinggi. Tingkatan ini cocok untuk pelatihan dan inferensi AI, klaster berskala sangat besar, dan beban kerja misi-kritis.

    Untuk informasi tentang biaya manajemen klaster untuk edisi Pro dan provisioned control plane, lihat Biaya manajemen klaster.

    ack.pro.small
    region_id

    string

    No

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

    cn-hangzhou
    cluster_id

    string

    No

    ID klaster.

    c3fb96524f9274b4495df0f12a6b5****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Badan respons.

    clusters

    array<object>

    Daftar informasi klaster.

    array<object>

    Instans klaster.

    cluster_id

    string

    ID klaster.

    c3fb96524f9274b4495df0f12a6b5****
    cluster_type

    string

    Jenis klaster.

    Kubernetes
    created

    string

    Waktu saat klaster dibuat.

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

    string

    Versi klaster. Untuk informasi selengkapnya tentang versi Kubernetes yang didukung oleh ACK, lihat Ikhtisar rilis versi Kubernetes.

    1.32.1-aliyun.1
    current_version

    string

    Versi klaster saat ini.

    1.32.1-aliyun.1
    next_version

    string

    Versi yang dapat ditingkatkan untuk klaster.

    1.xx.x-aliyun.1
    deletion_protection

    boolean

    Menunjukkan apakah perlindungan penghapusan diaktifkan untuk klaster. Ini mencegah penghapusan klaster secara tidak sengaja melalui konsol atau API. Nilai yang valid:

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

    • false: Perlindungan penghapusan dinonaktifkan. Klaster dapat dihapus melalui konsol atau API.

    true
    docker_version deprecated

    string

    Versi Docker klaster.

    19.03.5
    external_loadbalancer_id deprecated

    string

    ID instans Server Load Balancer (SLB) untuk Ingress di klaster.

    Jenis instans default: instans kinerja terjamin (slb.s1.small).

    lb-2vcrbmlevo6kjpgch****
    master_url

    string

    Alamat akses server API klaster, 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 klaster.

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

    string

    Nama klaster.

    cluster-demo
    network_mode deprecated

    string

    Mode jaringan klaster. Nilai yang valid:

    • classic: jaringan klasik.

    • vpc: virtual private cloud (VPC).

    • overlay: jaringan overlay.

    • calico: jaringan Calico.

    vpc
    private_zone deprecated

    boolean

    Konfigurasi Private Zone klaster. Nilai yang valid:

    • true: Private Zone diaktifkan.

    • false: Private Zone dinonaktifkan.

    false
    profile

    string

    Subjenis klaster.

    Default
    region_id

    string

    ID wilayah klaster.

    cn-beijing
    resource_group_id

    string

    ID grup sumber daya klaster.

    rg-acfmyvw3wjm****
    security_group_id

    string

    ID grup keamanan klaster.

    sg-2vcgwsrwgt5mp0yi****
    container_cidr

    string

    Blok CIDR pod. Ini adalah konfigurasi jaringan Flannel.

    172.20.xx.xx/16
    service_cidr

    string

    Blok CIDR layanan.

    172.21.xx.xx/20
    proxy_mode

    string

    Mode kube-proxy. Nilai yang valid:

    • iptables: Mode kube-proxy yang matang dan stabil. Penemuan layanan dan penyeimbangan beban untuk Kubernetes Services dikonfigurasi menggunakan aturan iptables. Kinerjanya moderat dan dipengaruhi oleh skala klaster. Mode ini cocok untuk klaster dengan jumlah Services yang sedikit.

    • ipvs: Mode kube-proxy berkinerja tinggi. Penemuan layanan dan penyeimbangan beban untuk Kubernetes Services dikonfigurasi menggunakan modul Linux IPVS. Mode ini cocok untuk klaster dengan jumlah Services yang besar yang memerlukan kinerja penyeimbangan beban yang tinggi.

    ipvs
    timezone

    string

    Zona waktu.

    Asia/Shanghai
    ip_stack

    string

    Tumpukan protokol IP klaster. Nilai yang valid:

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

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

    ipv4
    cluster_domain

    string

    Nama domain lokal klaster.

    cluster.local
    size

    integer

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

    5
    state

    string

    Status berjalan 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 dalam status diakses, menunggu untuk dihubungkan.

    • disconnected: Klaster terputus.

    running
    subnet_cidr deprecated

    string

    [Bidang ini telah dihentikan] Gunakan container_cidr untuk mendapatkan blok CIDR pod.

    null
    tags

    array

    Tag sumber daya klaster.

    tag

    Tag sumber daya klaster.

    updated

    string

    Waktu saat klaster terakhir diperbarui.

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

    string

    ID VPC klaster.

    vpc-2vcg932hsxsxuqbgl****
    vswitch_id deprecated

    string

    ID vSwitch klaster.

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

    array

    vSwitch bidang kontrol klaster.

    string

    vSwitch bidang kontrol klaster.

    vsw-2vc41xuumx5z2rdma****
    worker_ram_role_name deprecated

    string

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

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

    string

    ID zona klaster.

    cn-beijing-b
    cluster_spec

    string

    Spesifikasi klaster.

    ack.standard
    maintenance_window maintenance_window

    Jendela pemeliharaan klaster. Fitur ini hanya berlaku untuk klaster terkelola ACK dan klaster ACK Serverless.

    operation_policy

    object

    Kebijakan O&M otomatis klaster.

    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.