Query a cluster - API Reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses the common request header only. For more information, see Common parameters.

Request syntax

GET /clusters/[ClusterId] HTTPS|HTTP

Request parameters


Parameter	Type	Required	Example	Description
ClusterId	String	Yes	cdde1f21ae22e483ebcb068a6eb7f****	The ID of the cluster.

Response parameters


Parameter	Type	Example	Description
cluster_id	String	c82e6987e2961451182edacd74faf****	The ID of the cluster.
cluster_type	String	Kubernetes	The type of the cluster.
current_version	String	1.14.8-aliyun.1	The version of the cluster.
data_disk_category	String	cloud	The type of the data disks.
data_disk_size	Integer	0	The size of a data disk.
deletion_protection	Boolean	true	Indicates whether deletion protection is enabled for the cluster. If this feature is enabled, the cluster cannot be deleted by operations in the console or API operations.
docker_version	String	18.09.2	The version of Docker.
instance_type	String	""	The ECS instance type.
meta_data	String	****	The metadata of the cluster.
name	String	test-k8s	The name of the cluster.
network_mode	String	vpc	The network type of the cluster. vpc indicates Virtual Private Cloud (VPC).
region_id	String	cn-beijing	The ID of the region where the cluster is deployed.
resource_group_id	String	rg-acfmyvw3wjm****	The ID of the resource group to which the cluster belongs.
security_group_id	String	sg-25yq****	The ID of the security group to which the ECS instances in the cluster belong.
state	String	running	The status of the cluster. Valid values: running and stopped.
tags	Array		The tags of the cluster.
key	String	type	The name of the tag.
value	String	web	The value of the tag.
vpc_id	String	vpc-2zecuu62b9zw7a7qn****	The ID of the VPC to which the cluster is connected.
vswitch_cidr	String	""	The prefix length of the CIDR block that is assigned to VSwitches.
vswitch_id	String	"vsw-2zete8s4qocqg0mf6**,vsw-2zete8s4qocqg0mf6,vsw-2zete8s4qocqg0mf6,vsw-2zete8s4qocqg0mf6**"	The IDs of VSwitches.
zone_id	String	cn-beijing-a	The ID of the zone where the cluster is deployed.

Examples

Sample requests

GET /clusters/[ClusterId] HTTP/1.1
Common request header
{
"ClusterId": "cdde1f21ae22e483ebcb068a6eb7f****"
}

Sample success responses

XML format

<resource_group_id>rg-acfmyvw3wjm****</resource_group_id>
<vpc_id>vpc-2zecuu62b9zw7a7q****v</vpc_id>
<deletion_protection>true</deletion_protection>
<network_mode>vpc</network_mode>
<region_id>cn-beijing</region_id>
<current_version>1.14.8-aliyun.1</current_version>
<security_group_id>sg-25yqj***</security_group_id>
<cluster_type>Kubernetes</cluster_type>
<docker_version>18.09.2</docker_version>
<vswitch_cidr>""</vswitch_cidr>
<data_disk_category>cloud</data_disk_category>
<tags>
    <value>web</value>
    <key>type</key>
</tags>
<zone_id>cn-beijing-a</zone_id>
<cluster_id>c82e6987e2961451182edacd74faf****</cluster_id>
<data_disk_size>0</data_disk_size>
<name>test-k8s</name>
<meta_data>****</meta_data>
<vswitch_id>"vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf****"</vswitch_id>
<state>running</state>
<instance_type>""</instance_type>

JSON format

{"resource_group_id":"rg-acfmyvw3wjm****","vpc_id":"vpc-2zecuu62b9zw7a7qn****","deletion_protection":"true","network_mode":"vpc","region_id":"cn-beijing","current_version":"1.14.8-aliyun.1","security_group_id":"sg-25yqj***","cluster_type":"Kubernetes","docker_version":"18.09.2","vswitch_cidr":"\"\"","data_disk_category":"cloud","tags":[{"value":"web","key":"type"}],"zone_id":"cn-beijing-a","cluster_id":"c82e6987e2961451182edacd74faff76e","data_disk_size":"0","name":"test-k8s","meta_data":"****","vswitch_id":"\"vsw-2zete8s4qocqg0mf6xd76,vsw-2zete8s4qocqg0mf6xd76,vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****\"","state":"running","instance_type":"\"\""}

Error codes

For a list of error codes, visit the API Error Center.