DescribeClusterDetail - ENS - Alibaba Cloud Documentation Center

Queries the details of a cluster.

Operation description

You can call this operation up to 100 times per second.

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

ens:DescribeClusterDetail

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster.	eck-11111111

Response elements

Element	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
ClusterId	string	The ID of the cluster.	eck-11111111
Name	string	The name of the cluster.	your-cluster-name
AliUid	string	The user ID.	1574790082031102
EnsRegionId	string	The ID of the ENS edge zone.	cn-fuzhou-23
KubernetesVersion	string	The version of the cluster. It is consistent with the baseline version of the Kubernetes community. Select the latest version. If you do not specify a version, the latest version is used by default.	1.32.1.aliyunedge.1
VpcId	string	The virtual private cloud (VPC) that the cluster uses.	n-xxxxxxxxx
VswitchIds	array	The IDs of the virtual switches that contain the cluster nodes.
	string	The ID of the virtual switch associated with the cluster node.	vsw-xxxxxxxxx
PodVswitchIds	array	The ID of the pod virtual switch.
	string	The ID of the pod virtual switch.	vsw-xxxxxxxx
ContainerCidr	string	The CIDR block for pods.	172.20.0.0/16
ServiceCidr	string	The CIDR block for services.	172.19.0.0/20
PublicAccess	boolean	Indicates whether public network access is enabled.	true
LoadBalancerId	string	The ID of the CLB instance for the API server.	lb-5snthcyu1x10g7tywj7iu****
ControlPlaneConfig	object	The configuration of the control plane.
InstanceSpec	string	The instance type for the node.	ens.esk.sn1.medium
ImageId	string	The ID of the virtual machine image for the control plane.	m-5ul335umat4e2y9ynwi84p3f9
SystemDiskCategory	string	The system disk category of the node.	cloud_efficiency
SystemDiskSize	integer	The size of the system disk for the node.	120
ContainerRuntime	string	The type of the runtime.	containerd
NodePortRange	string	The range of service ports for the node.	30000-32767
Size	integer	The number of control plane nodes.	3
JoinToken	string	The authentication token for joining the cluster.	xxxx.yyy
Config	any	The kubeconfig of the cluster.	apiVersion: v1 clusters: - cluster: certificate-authority-data: x server: https://111.111.111.111:6443 name: kubernetes contexts: - context: cluster: kubernetes user: user name: eck-xxxxx current-context: eck-xxxx kind: Config preferences: {} users: - name: user user: client-certificate-data: x client-key-data: x
State	string	The state of the cluster. initial: The cluster is being created. failed: The cluster failed to be created. running: The cluster is running. deleting: The cluster is being released.	running

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ClusterId": "eck-11111111",
  "Name": "your-cluster-name",
  "AliUid": "1574790082031102",
  "EnsRegionId": "cn-fuzhou-23",
  "KubernetesVersion": "1.32.1.aliyunedge.1",
  "VpcId": "n-xxxxxxxxx",
  "VswitchIds": [
    "vsw-xxxxxxxxx"
  ],
  "PodVswitchIds": [
    "vsw-xxxxxxxx"
  ],
  "ContainerCidr": "172.20.0.0/16",
  "ServiceCidr": "172.19.0.0/20",
  "PublicAccess": true,
  "LoadBalancerId": "lb-5snthcyu1x10g7tywj7iu****",
  "ControlPlaneConfig": {
    "InstanceSpec": "ens.esk.sn1.medium",
    "ImageId": "m-5ul335umat4e2y9ynwi84p3f9",
    "SystemDiskCategory": "cloud_efficiency",
    "SystemDiskSize": 120,
    "ContainerRuntime": "containerd",
    "NodePortRange": "30000-32767",
    "Size": 3
  },
  "JoinToken": "xxxx.yyy",
  "Config": "apiVersion: v1\nclusters:\n- cluster:\n    certificate-authority-data: x\n    server: https://111.111.111.111:6443\n  name: kubernetes\ncontexts:\n- context:\n    cluster: kubernetes\n    user: user\n  name: eck-xxxxx\ncurrent-context: eck-xxxx\nkind: Config\npreferences: {}\nusers:\n- name: user\n  user:\n    client-certificate-data: x\n    client-key-data: x",
  "State": "running"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.