DescribeClusterNodes

Description

call DescribeClusterNodes to query cluster nodes.

Request Method

POST

Request Path

/apsara/route/CS/DescribeClusterNodes

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
pageNumber	BODY	string	No	50	shows the number of pages.
ClusterId	BODY	string	Yes	c82e6987e2961451182edacd74faf	cluster ID.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
pageSize	BODY	string	No	3	paging size.
state	BODY	string	No	all	cluster status, filter according to the cluster running status, value: all: clusters in the following 4 states. running: running cluster. removing: the cluster being deleted. initial: the cluster being initialized. failed: the cluster that failed to be created.
nodepool_id	BODY	string	No	np***	node pool ID.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
creation_time	string	2020-08-25T11:25:35+08:00	node creation time.
error_message	string	1234	error message when the node was created.
instance_name	string	worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f1234	the name of the node in the cluster.
node_status	string	Ready	whether the node is ready.
total_count	integer	5	total number of results.
is_aliyun_node	boolean	true	is an alibaba cloud instance.
node_name	string	cn-chengdu. 192.168.0.36	node name, node identification in the cluster.
expired_time	string	2099-12-31T23:59:00+08:00	node expiration time.
ip_address	array of string	No sample value for this parameter.	node IP address.
source	string	ess_attach	what is the node initialized, for example: manual creation or ROS creation.
instance_type_family	string	ecs.c5	ECS family name to which the node belongs.
nodes	array of node	No sample value for this parameter.	node details list.
instance_id	string	i-2vcckdmxp7u0urj2k2rw	node instance ID.
page_number	integer	1	page number.
instance_charge_type	string	PostPaid	node payment type.
instance_role	string	Worker	node role type: Master: cluster master node. Worker: Cluster Worker node.
instance_status	string	Running	node running status.
state	string	running	node running status.
page	object	No sample value for this parameter.	paging information.
image_id	string	aliyun_2_1903_x64_20G_alibase_20200529.vhd	the system image ID used by the node.
instance_type	string	ecs.c5.xlarge	node type.
nodepool_id	string	np0794239424a84eb7a95327369d561234	node pool ID.
host_name	string	iZ2vcckdmxp7u0urj2k1234	node hostname.
page_size	integer	10	single page size.

Example

Successful Response example

{
 "creation_time":"2020-08-25T11:25:35+08:00",
 "error_message":"1234",
 "instance_name":"worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f1234",
 "node_status":"Ready",
 "total_count":"5",
 "is_aliyun_node":"true",
 "node_name":"cn-chengdu. 192.168.0.36",
 "expired_time":"2099-12-31T23:59:00+08:00",
 "ip_address":"",
 "source":"ess_attach",
 "instance_type_family":"ecs.c5",
 "nodes":"",
 "instance_id":"i-2vcckdmxp7u0urj2k2rw",
 "page_number":"1",
 "instance_charge_type":"PostPaid",
 "instance_role":"Worker",
 "instance_status":"Running",
 "state":"running",
 "page":"",
 "image_id":"aliyun_2_1903_x64_20G_alibase_20200529.vhd",
 "instance_type":"ecs.c5.xlarge",
 "nodepool_id":"np0794239424a84eb7a95327369d561234",
 "host_name":"iZ2vcckdmxp7u0urj2k1234",
 "page_size":"10"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}