DescribeClusterDetail-阿里云帮助中心

Call the DescribeClusterDetail operation to get the details of a cluster by its cluster ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:DescribeClusterDetail

get

*Cluster

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

None

Request syntax

GET /clusters/{ClusterId} HTTP/1.1

Path Parameters

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

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response body parameters.
cluster_id	string	The cluster ID.	c82e6987e2961451182edacd74faf****
cluster_type	string	The type of the cluster. `Kubernetes`: An ACK dedicated cluster. `ManagedKubernetes`: An ACK managed cluster. This category includes standard and Pro editions of ACK managed, ACK Serverless, and ACK Edge clusters, as well as ACK Lingjun clusters (Pro edition only). `ExternalKubernetes`: A registered cluster.	Kubernetes
created	string	The time when the cluster was created.	2025-04-07T09:57:26+08:00
init_version	string	The initial version of the cluster.	1.32.1-aliyun.1
current_version	string	The current Kubernetes version of the cluster. For more information about the Kubernetes versions supported by ACK, see Overview of Kubernetes version releases.	1.32.1-aliyun.1
next_version	string	The Kubernetes versions to which the cluster can be upgraded.	1.xx.x-aliyun.1
deletion_protection	boolean	Indicates whether deletion protection is enabled for the cluster. If deletion protection is enabled, the cluster cannot be accidentally deleted in the console or by calling an API operation. Valid values: `true`: The cluster is protected from accidental deletion through the console or API calls. `false`: The cluster is not protected from accidental deletion.	true
docker_version `deprecated`	string	The Docker version of the cluster.	19.03.5
external_loadbalancer_id `deprecated`	string	The ID of the Ingress LoadBalancer instance.	lb-2zehc05z3b8dwiifh****
meta_data	string	The cluster metadata.	\"Addons\":***
name	string	The cluster name.	cluster-demo
network_mode `deprecated`	string	The network type used by the cluster, for example, a Virtual Private Cloud (VPC).	vpc
region_id	string	The ID of the region where the cluster is deployed.	cn-beijing
resource_group_id	string	The ID of the resource group to which the cluster belongs.	rg-acfmyvw3wjm****
security_group_id	string	The ID of the security group to which the cluster belongs.	sg-25yq****
size	integer	The total number of nodes in the cluster, including master nodes and worker nodes.	5
state	string	The state of the cluster. Valid values: `initial`: The cluster is being created. `failed`: The cluster creation failed. `running`: The cluster is running. `updating`: The cluster is being updated. `upgrading`: The cluster is being upgraded. `removing`: Nodes are being removed. `draining`: Nodes are being drained. `scaling`: The cluster is being scaled. `inactive`: The cluster is inactive. `unavailable`: The cluster is unavailable. `deleting`: The cluster is being deleted. `deleted`: The cluster is deleted. `delete_failed`: The cluster deletion failed. `waiting`: The cluster is waiting to connect. `disconnected`: The cluster is disconnected.	running
tags	array	The resource tags of the cluster.
	tag	A tag that is attached to the cluster.
updated	string	The time when the cluster was last updated.	2025-04-10T13:28:09+08:00
vpc_id	string	The ID of the Virtual Private Cloud (VPC) to which the cluster belongs. This parameter is required when you create a cluster.	vpc-2zecuu62b9zw7a7qn****
vswitch_id `deprecated`	string	The vSwitch ID. This parameter is deprecated. To query the vSwitches for the control plane, use the `vswitch_ids` parameter in this response. To query the vSwitches for the data plane, check the `vswitch_ids` parameter of the relevant node pool.	vsw-2zete8s4qocqg0mf6**,vsw-2zete8s4qocqg0mf6**
subnet_cidr `deprecated`	string	The Pod CIDR block.	172.20.xx.xx/16
zone_id `deprecated`	string	The ID of the availability zone where the cluster is deployed.	cn-beijing-a
master_url	string	The internal and public API server endpoints for the cluster.	{\"intranet_api_server_endpoint\":\"https://192.168.xx.xx:6443\"***}
private_zone `deprecated`	boolean	Indicates whether PrivateZone is enabled for the cluster. `true`: enabled. `false`: disabled. Default value: false.	false
profile	string	The subtype of the cluster. `Default`: ACK managed clusters (standard and Pro editions). `Edge`: ACK Edge clusters (standard and Pro editions). `Serverless`: ACK Serverless clusters (standard and Pro editions). `Lingjun`: ACK Lingjun clusters (Pro edition only).	Default
cluster_spec	string	The specification of the cluster if `cluster_type` is set to `ManagedKubernetes` and `profile` is configured. Valid values: `ack.standard`: standard edition (selected by default if not specified) `ack.pro.small`: Pro edition `ack.pro.xlarge`: Pro XL `ack.pro.2xlarge`: Pro 2XL `ack.pro.4xlarge`: Pro 4XL (You need to contact customer support to be added to the whitelist.) Pro XL, Pro 2XL, and Pro 4XL are three tiers provided by ACK Pro with provisioned control plane. This feature ensures a high level of API concurrency and pod scheduling by pre-allocating and dedicating control plane resources, making it ideal for AI training and inference, ultra-large clusters, and mission-critical workloads. For more information about the management fees for Pro edition clusters and clusters with a provisioned control plane, see Cluster management fee.	ack.pro.small
worker_ram_role_name	string	The name of the worker RAM role that grants permissions to the ECS instances to act as worker nodes of the cluster.	KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****
maintenance_window	maintenance_window	The maintenance window configuration of the cluster. This feature is available only for ACK Pro clusters.
parameters `deprecated`	object	The Resource Orchestration Service (ROS) parameters of the cluster.
	string	A ROS parameter.	"ALIYUN::Region": "cn-qingdao"
container_cidr	string	The Pod CIDR block for Flannel networking.	172.20.xx.xx/16
service_cidr	string	The Service CIDR block.	172.21.xx.xx/20
proxy_mode	string	The kube-proxy proxy mode. `iptables`: A mature and stable proxy mode that uses iptables rules for Service discovery and load balancing. Its performance is affected by the number of Services, making it suitable for smaller-scale clusters. `ipvs`: A high-performance proxy mode that uses the Linux IP Virtual Server (IPVS) module. It is suitable for large-scale clusters that require high-performance load balancing.	ipvs
timezone	string	The time zone of the cluster.	Asia/Shanghai
node_cidr_mask	string	The subnet mask length for each node, which determines the number of IP addresses that can be allocated per node. This parameter is applicable only to clusters that use the Flannel network plug-in. The subnet mask size for node allocation determines how many IP addresses a node can assign.	26
ip_stack	string	The IP stack of the cluster. Valid values: `ipv4`: The cluster supports only IPv4. dual: Create a cluster that supports IPv4/IPv6 dual-stack.	ipv4
cluster_domain	string	The cluster-internal domain name.	cluster.local
extra_sans	array	The custom subject alternative names (SANs) for the API server certificate.
	string	A certificate SAN.	192.168.xx.xx
rrsa_config	object	The configurations of RAM Roles for Service Accounts (RRSA).
enabled	boolean	Indicates whether the RRSA feature is enabled.	true
oidc_name	string	The name of the OIDC identity provider.	ack-rrsa-***
oidc_arn	string	The ARN of the OIDC identity provider.	acs:ram::1138*:oidc-provider/ack-rrsa-*
max_oidc_token_expiration	string	The maximum validity period of an OIDC token.	12h
audience	string	The default audience of the OIDC token. If multiple values are specified, the values must be separated by commas (,). This value is used as the audience (`aud`) claim in the OIDC token.	https://kubernetes.default.svc,https://example.***.com
issuer	string	The issuer of the OIDC token. If multiple values are specified, the values must be separated by commas (,). The first value is used as the issuer (`iss`) claim and the issuer URL for the OIDC identity provider.	https://oidc-ack-***,https://kubernetes.default.svc
open_api_configuration_url	string	The URL of the OIDC discovery document.	https://oidc-ack-*/c12b990*/.well-known/openid-configuration
jwks_url	string	The URL of the JSON Web Key Set (JWKS) that contains the OIDC public keys.	https://oidc-ack-*/c12b990*/keys
vswitch_ids	array	The vSwitches of the control plane.
	string	A vSwitch of the control plane.	vsw-2zete8s4qocqg0mf6****
operation_policy	object	The cluster auto-operation policy.
cluster_auto_upgrade	object	The cluster auto-upgrade settings.
enabled	boolean	Indicates whether cluster auto-upgrade is enabled.	true
channel	string	The auto-upgrade channel. For more information, see Upgrade channels. Valid values: `patch`: the latest patch version. `stable`: the second-latest minor version. `rapid`: the latest minor version.	patch
control_plane_config	object	The control plane configurations of the ACK dedicated cluster.
charge_type	string	The billing method of the control plane nodes.	PrePaid
period	integer	The subscription duration of the control plane nodes.	1
period_unit	string	The unit of the subscription duration.	Month
auto_renew	boolean	Indicates whether auto-renewal is enabled for the nodes.	true
auto_renew_period	integer	The auto-renewal duration for the nodes.	1
instance_types	array	The instance types of the nodes.
	string	The instance type.	ecs.g6.large
image_type	string	The OS image type.	AliyunLinux3
image_id	string	The image ID.	aliyun_3_x64_20G_alibase_20240819
key_pair	string	The name of the key pair. You must specify this parameter or `login_password`.	ack
system_disk_category	string	The type of the system disk for the nodes.	cloud_essd
system_disk_size	integer	The size of the system disk for the control plane nodes, in GiB. The value must be at least 40.	120
system_disk_snapshot_policy_id	string	The ID of the automatic snapshot policy for the system disks of control plane nodes.	sp-2zej1nogjvovnz4z****
system_disk_performance_level	string	The performance level of the system disk for the nodes. This parameter is valid only for ESSDs.	PL1
system_disk_provisioned_iops	integer	The provisioned read/write IOPS of the system disk for the nodes.	1000
system_disk_bursting_enabled	boolean	Indicates whether bursting is enabled for the system disk of the nodes.	true
deploymentset_id	string	The ID of the deployment set.	ds-bp10b35imuam5amw****
cloud_monitor_flags	boolean	Indicates whether the CloudMonitor agent is installed on the nodes.	true
soc_enabled	boolean	Indicates whether MLPS security hardening is enabled.	false
security_hardening_os	boolean	Indicates whether Alibaba Cloud OS security hardening is enabled.	true
cpu_policy	string	The CPU management policy for the nodes.	none
runtime	string	The name of the container runtime.	containerd
node_port_range	string	The NodePort range for Services.	30000-32767
size	integer	The number of control plane nodes.	3
instance_metadata_options	InstanceMetadataOptions	The metadata access configurations of the ECS instances.
auto_mode	object	The intelligent hosting mode configurations.
enable	boolean	Indicates whether the intelligent hosting mode is enabled.	false
control_plane_endpoints_config	object	The cluster connection configurations.
internal_dns_config	object	Internal DNS settings for the cluster. This parameter is applicable only to ACK managed clusters. Node components, such as kubelet and kube-proxy, use the internal domain name to access the API server. If this feature is disabled, these components access the API server by using the IP address of its Classic Load Balancer (CLB) instance.
bind_vpcs	array	The VPCs in which the internal domain name takes effect. By default, this includes the VPC where the cluster is deployed.
	string	A VPC in which the internal domain name takes effect.	vpc-xxxxxx
enabled	boolean	Indicates whether internal DNS-based access is enabled. `true`: Internal DNS-based access is enabled. Node components such as kubelet and kube-proxy access the API server by using the internal domain name.	true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.