全部產品
Search
文件中心

Container Service for Kubernetes:DescribeClusterDetail - 查詢指定叢集的資訊

更新時間:May 22, 2026

您可以調用DescribeClusterDetail介面,根據叢集ID查詢指定叢集的詳細資料。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cs:DescribeClusterDetail

get

*Cluster

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

請求文法

GET /clusters/{ClusterId} HTTP/1.1

路徑參數

名稱

類型

必填

描述

樣本值

ClusterId

string

叢集 ID。

cdde1f21ae22e483ebcb068a6eb7f****

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱

類型

描述

樣本值

object

返回體參數。

cluster_id

string

叢集 ID。

c82e6987e2961451182edacd74faf****

cluster_type

string

叢集類型。

  • Kubernetes: ACK 專有叢集。

  • ManagedKubernetes:ACK 託管類的叢集,包括 ACK 託管叢集(ACK 叢集 Pro 版、ACK 叢集基礎版)、ACK Serverless 叢集(Pro 版、基礎版)、ACK Edge 叢集(Pro 版、基礎版)、ACK 靈駿叢集(Pro 版)。

  • ExternalKubernetes:註冊叢集。

Kubernetes

created

string

叢集建立時間。

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

init_version

string

叢集初始化版本。

1.32.1-aliyun.1

current_version

string

叢集目前的版本。ACK 支援的 Kubernetes 版本,請參見 Kubernetes 版本發布概覽

1.32.1-aliyun.1

next_version

string

叢集可升級版本。

1.xx.x-aliyun.1

deletion_protection

boolean

叢集刪除保護,防止通過控制台或 API 誤刪除叢集。取值:

  • true:啟用叢集刪除保護,將不能通過控制台或 API 刪除叢集。

  • false:不啟用叢集刪除保護,則能通過控制台或 API 刪除叢集。

true

docker_version deprecated

string

叢集中的 Docker 版本。

19.03.5

external_loadbalancer_id deprecated

string

叢集 Ingress LB 執行個體 ID。

lb-2zehc05z3b8dwiifh****

meta_data

string

叢集中繼資料資訊。

\"Addons\":***

name

string

叢集名稱。

cluster-demo

network_mode deprecated

string

叢集採用的網路類型,例如:VPC 網路。

vpc

region_id

string

叢集所在地區 ID。

cn-beijing

resource_group_id

string

叢集資源群組 ID。

rg-acfmyvw3wjm****

security_group_id

string

叢集安全性群組 ID。

sg-25yq****

size

integer

叢集節點數,包含 Master 節點及 Worker 節點。

5

state

string

叢集運行狀態,取值:

  • initial:叢集建立中。

  • failed:叢集建立失敗。

  • running:叢集運行中。

  • updating:叢集變更中。

  • upgrading:叢集升級中。

  • removing:節點移除中。

  • draining:節點排水中。

  • scaling:叢集伸縮中。

  • inactive:叢集不活躍。

  • unavailable:叢集不可用。

  • deleting:叢集刪除中。

  • deleted:叢集已經被刪除。

  • delete_failed:叢集刪除失敗。

  • waiting:等待接入狀態。

  • disconnected:斷開狀態。

running

tags

array

叢集資源標籤。

tag

叢集資源標籤。

updated

string

叢集更新時間。

2025-04-10T13:28:09+08:00

vpc_id

string

叢集專用網路 ID,建立叢集時的必填參數。

vpc-2zecuu62b9zw7a7qn****

vswitch_id deprecated

string

虛擬交換器 ID。該欄位已廢棄,控制面交換器請使用 vswitch_ids 查詢,資料面交換器請通過節點池的 vswitch_ids 查詢。

vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****

subnet_cidr deprecated

string

Pod 網路位址區段。

172.20.xx.xx/16

zone_id deprecated

string

叢集所在地區內的可用性區域 ID。

cn-beijing-a

master_url

string

叢集訪問地址,包含內網訪問地址及公網訪問地址。

{\"intranet_api_server_endpoint\":\"https://192.168.xx.xx:6443\"***}

private_zone deprecated

boolean

叢集是否啟用 PrivateZone。

  • true:啟用。

  • false:不啟用 。

預設值:false。

false

profile

string

叢集子類型。

  • Default:ACK 託管叢集,包括 ACK 叢集 Pro 版和 ACK 叢集基礎版。

  • Edge:ACK Edge 叢集,包括 ACK Edge 叢集 Pro 版和 ACK Edge 叢集基礎版。

  • Serverless:ACK Serverless 叢集,包括 ACK Serverless 叢集 Pro 版和 ACK Serverless 叢集基礎版。

  • Lingjun:ACK 靈駿叢集,提供 Pro 版。

Default

cluster_spec

string

選擇cluster_typeManagedKubernetes並配置profile時,叢集的規格。取值:

  • ack.standard:基礎版(取值為空白時預設選擇)

  • ack.pro.small:Pro 版

  • ack.pro.xlarge:Pro XL

  • ack.pro.2xlarge:Pro 2XL

  • ack.pro.4xlarge: Pro 4XL (需聯絡客服開通白名單)

Pro XL、Pro 2XL、Pro 4XL 為ACK Pro 預設控制面提供的三個檔位,通過預先分配並固化控制面資源,確保 API 並發與 Pod 調度能力始終處於確定的高水平狀態,適用於 AI 訓練推理、超大規模叢集及關鍵任務型業務。

Pro 版及預設控制面版本的叢集管理費用請參見叢集管理費用

ack.pro.small

worker_ram_role_name

string

Worker RAM 角色名稱,授權 ECS 執行個體為叢集 Woker 節點。

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

maintenance_window maintenance_window

叢集維護視窗配置,只在託管版本(即:ACK Pro 叢集)中生效。

parameters deprecated

object

叢集 ROS 參數集合。

string

ROS 參數。

"ALIYUN::Region": "cn-qingdao"

container_cidr

string

Pod 網路網段,Flannel 網路設定。

172.20.xx.xx/16

service_cidr

string

服務網路網段。

172.21.xx.xx/20

proxy_mode

string

kube-proxy 代理模式

  • iptables: 成熟穩定的 kube-proxy 代理模式,Kubernetes Service 的服務發現和負載平衡使用 iptables 規則配置,但是效能一般,受規模影響較大,適用於叢集存在少量的 Service。

  • ipvs:高效能的 kube-proxy 代理模式,Kubernetes Service 的服務發現和負載平衡使用 Linux IPVS 模組進行配置,適用於叢集存在大量的 Service,對負載平衡有高效能要求的情境。

ipvs

timezone

string

時區。

Asia/Shanghai

node_cidr_mask

string

僅適用於 Flannel 網路外掛程式。

節點分配的子網路遮罩大小,用於控制節點可以分配的 IP 位址的數量。

26

ip_stack

string

叢集的 IP 協議棧,可取值:

  • ipv4:建立僅支援 IPv4 協議棧的叢集;

  • dual:建立支援 IPv4/IPv6 雙棧的叢集。

ipv4

cluster_domain

string

叢集本地區名。

cluster.local

extra_sans

array

自訂的 API Server 認證 SAN(Subject Alternative Name)。

string

認證 SAN。

192.168.xx.xx

rrsa_config

object

RRSA 配置。

enabled

boolean

是否啟用 RRSA。

true

oidc_name

string

OIDC 身份供應商名稱。

ack-rrsa-***

oidc_arn

string

OIDC 身份供應商 ARN。

acs:ram::1138***:oidc-provider/ack-rrsa-***

max_oidc_token_expiration

string

OIDC Token 可配置的最大有效期間。

12h

audience

string

OIDC Token 的預設受眾資訊。包含多個值時將使用英文逗號(,)分隔。該值將以數組形式成為 OIDC Token 中 aud 欄位的值。

https://kubernetes.default.svc,https://example.***.com

issuer

string

OIDC Token 的簽發者資訊。包含多個值時將使用英文逗號(,)分隔。其中第一個值將成為 OIDC Token 中 iss 欄位的值以及 OIDC 身份供應商的頒發者 URL。

https://oidc-ack-***,https://kubernetes.default.svc

open_api_configuration_url

string

OIDC 配置文檔 URL。

https://oidc-ack-***/c12b990***/.well-known/openid-configuration

jwks_url

string

OIDC 公開金鑰資訊 URL。

https://oidc-ack-***/c12b990***/keys

vswitch_ids

array

叢集控制面虛擬交換器。

string

叢集控制面虛擬交換器。

vsw-2zete8s4qocqg0mf6****

operation_policy

object

叢集自動營運策略。

cluster_auto_upgrade

object

叢集自動升級。

enabled

boolean

是否開啟叢集自動升級。

true

channel

string

叢集自動升級頻次。更多資訊,請參見升級頻次

可取值:

  • patch:最新補丁版本。

  • stable:次新次要版本。

  • rapid:最新次要版本。

patch

control_plane_config

object

專有版叢集控制面配置。

charge_type

string

控制面節點付費類型。

PrePaid

period

integer

節點訂用帳戶時間長度。

1

period_unit

string

節點訂用帳戶時間單位。

Month

auto_renew

boolean

節點是否自動續約。

true

auto_renew_period

integer

節點自動續約時間長度。

1

instance_types

array

節點執行個體規格類型。

string

執行個體規格。

ecs.g6.large

image_type

string

作業系統鏡像類型。

AliyunLinux3

image_id

string

鏡像 ID。

aliyun_3_x64_20G_alibase_20240819

key_pair

string

金鑰組名稱,和 login_password 二選一。

ack

system_disk_category

string

節點系統硬碟類型。

cloud_essd

system_disk_size

integer

節點系統硬碟大小,至少 40。

120

system_disk_snapshot_policy_id

string

節點自動快照備份策略。

sp-2zej1nogjvovnz4z****

system_disk_performance_level

string

節點系統硬碟磁碟效能,只針對 ESSD 磁碟生效。

PL1

system_disk_provisioned_iops

integer

節點系統硬碟預配置的讀寫 IOPS。

1000

system_disk_bursting_enabled

boolean

節點系統硬碟是否開啟 Burst(效能突發)。

true

deploymentset_id

string

部署集 ID。

ds-bp10b35imuam5amw****

cloud_monitor_flags

boolean

是否為節點安裝CloudMonitor。

true

soc_enabled

boolean

是否開啟等保安全強化。

false

security_hardening_os

boolean

是否開啟阿里雲 OS 安全強化。

true

cpu_policy

string

節點 CPU 管理原則。

none

runtime

string

運行時名稱。

containerd

node_port_range

string

節點服務連接埠範圍。

30000-32767

size

integer

控制面節點數量。

3

instance_metadata_options InstanceMetadataOptions

ECS 執行個體的中繼資料訪問配置。

auto_mode

object

智能託管模式配置。

enable

boolean

是否開啟智能託管模式。

false

control_plane_endpoints_config

object

叢集串連配置。

internal_dns_config

object

叢集內部網域名稱配置,適用於 ACK 託管叢集。叢集內部網域名稱用於 kubelet、kube-proxy 等節點側系統組件訪問 API Server;未開啟叢集內部網域名稱訪問時,節點側系統組件將通過 CLB IP 方式訪問。

bind_vpcs

array

叢集內部網域名稱記錄解析生效的 VPC 範圍,預設包括叢集所在 VPC。

string

叢集內部網域名稱記錄解析生效的 VPC。

vpc-xxxxxx

enabled

boolean

是否開啟叢集內部網域名稱訪問。

  • true:開啟叢集內部網域名稱訪問,節點側組件(kubelet、kube-proxy)將通過叢集內部網域名稱訪問 API Server。

true

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情