DescribeClusterNodePools

Description

call DescribeClusterNodePoolDetail query cluster specified node pool details.

Request Method

POST

Request Path

/apsara/route/CS/DescribeClusterNodePools

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
ClusterId	BODY	string	Yes	c23421cfa74454bc8b37163fd19af	cluster ID.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
version	BODY	string	No	2016-01-01	version of api
NodepoolId	BODY	string	Yes	np31da1b38983f4511b490fc62108a	node pool ID.

Return data

Name	Type	Sample value	Description
instance_types	array of string	ecs.n4.large	node instance specification.
tee_config	object	No sample value for this parameter.	encrypt the computing section cluster configuration.
runtime_version	string	19.03.5	container runtime version.
resource_group_id	string	rg-acfmyvw3wjmb	resource group ID.
auto_scaling	object	No sample value for this parameter.	auto-scaling node pool configuration.
security_group_id	string	sg-2ze60ockeekspl3d	security group ID.
serving_nodes	long	3	number of nodes in work.
type	string	ess	node pool type.
platform	string	AliyunLinux	operating system release. Value: CentOS AliyunLinux Windows WindowsCore
data_disks	array of data_disk	No sample value for this parameter.	a combination of configurations such as node data disk type and size.
ram_policy	string	KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e	Worker RAM role name. The ECS instance is authorized to be the Woker node of the cluster.
login_password	string	No sample value for this parameter.	SSH login password. The password rule is 8 to 30 characters in length and contains at least three items (uppercase and lowercase letters, numbers, and special symbols). For security reasons, the password query results are encrypted.
enable	boolean	true	whether auto scaling is enabled. true: Turn on the automatic scaling function of the node pool. false: automatic scaling is not turned on. when the value is false,auto_scaling other configuration parameters will not take effect.
cms_enabled	boolean	true	whether to install cloud monitoring on the ECS node. after installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console. it is recommended to open it. Value: true: install cloud monitoring on ECS nodes. false: do not install cloud monitoring on ECS nodes.
state	string	active	node pool status, value: active: activated. scaling: scaling. removing: The node is being removed. deleting: being deleted. updating: Updating.
removing_nodes	long	0	Number of nodes being removed.
vswitch_ids	array of string	vsw-2ze3ds0mdip0hdz8i	virtual switch ID.
scaling_group_id	string	asg-2zeieod8giqmov7z	scaling group ID.
scaling_group	object	No sample value for this parameter.	expand group configuration.
created	string	2020-09-27T19:14:09.156823496+08:00	node pool creation time.
region_id	string	cn-beijing	region ID.
max_instances	long	10	Maximum number of instances.
runtime	string	docker	container runtime name.
taints	array of taint	No sample value for this parameter.	node taint information. Stain and tolerance (Toleration) cooperate with each other and can be used to prevent Pod from being assigned to inappropriate nodes. For more information, please refer to taint-and-toleration.
user_data	string	IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi	node pool custom data. For more information, see instance custom data in ECS.
is_default	boolean	true	whether it is the default node pool, usually a cluster has only one default node pool. Value: true: set as the default node pool. false: not set as the default node pool.
offline_nodes	long	0	number of offline nodes.
tee_enable	boolean	false	Whether to enable encrypted computing cluster, value: true: on. false: not on.
system_disk_size	long	120	node system disk size, unit is GiB. Value range:[20,500].
nodepool_info	object	No sample value for this parameter.	node pool configuration.
healthy_nodes	long	3	health node points.
labels	array of tag	No sample value for this parameter.	node label to add labels to Kubernetes cluster nodes. Label definition rules: tags consist of case-sensitive key-value pairs. you can set up to 20 tags. The tag key cannot be repeated. The maximum number is 64 characters. The tag value can be empty and the maximum number is 128 characters. The label key and label value cannot be aliyun, acs:, https:// or http:// beginning.
tags	array of tag	No sample value for this parameter.	tags only ECS instances. the tag key cannot be repeated, and the maximum length is 128 characters; neither the tag key nor the tag value can start with aliyun, acs:, or include https://, http://.
kubernetes_config	object	No sample value for this parameter.	cluster related configuration.
system_disk_category	string	cloud_efficiency	node system disk type, value: cloud_efficiency: efficient cloud disk. cloud_ssd:SSD cloud disk.
rds_instances	array of string	rm-xxx	RDS instance.
cpu_policy	string	none	node CPU management policy. The following two policies are supported when the cluster version is 1.12.6 and above: static: allows Pods with certain resource characteristics on the node to enhance their CPU affinity and exclusivity. none: indicates that the existing default CPU affinity scheme is enabled.
name	string	default-nodepool	node pool name. naming rule: consists of numbers, Chinese characters, English characters, or dashes (-), and the length ranges from 1 to 63 characters, and cannot start with a dash (-).
min_instances	long	1	minimum number of instances.
total_nodes	long	3	the total number of nodes in the node pool.
image_id	string	aliyun_2_1903_x64_20G_alibase_20200529.vhd	custom image ID, you can use DescribeKubernetesVersionMetadata to query the images supported by the system.
initial_nodes	long	0	number of nodes being created.
nodepool_id	string	np615c0e0966124216a0412e10afe0	node pool ID.
updated	string	2020-09-27T20:37:46+08:00	node pool update time.
failed_nodes	long	0	number of failed nodes.
scaling_policy	string	release	scaling group mode, value: release: standard mode, according to the usage of the requested resource value, scaling is performed by creating and releasing ECS instances. recycle: speed mode, which is scaled by creating, stopping and starting, increase the speed of retraction.
status	object	No sample value for this parameter.	node pool status configuration.

Example

Successful Response example

{
 "instance_types":"ecs.n4.large",
 "tee_config":"",
 "runtime_version":"19.03.5",
 "resource_group_id":"rg-acfmyvw3wjmb",
 "auto_scaling":"",
 "security_group_id":"sg-2ze60ockeekspl3d",
 "serving_nodes":"3",
 "type":"ess",
 "platform":"AliyunLinux",
 "data_disks":"",
 "ram_policy":"KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e",
 "login_password":"",
 "enable":"true",
 "cms_enabled":"true",
 "state":"active",
 "removing_nodes":"0",
 "vswitch_ids":"vsw-2ze3ds0mdip0hdz8i",
 "scaling_group_id":"asg-2zeieod8giqmov7z",
 "scaling_group":"",
 "created":"2020-09-27T19:14:09.156823496+08:00",
 "region_id":"cn-beijing",
 "max_instances":"10",
 "runtime":"docker",
 "taints":"",
 "user_data":"IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi",
 "is_default":"true",
 "offline_nodes":"0",
 "tee_enable":"false",
 "system_disk_size":"120",
 "nodepool_info":"",
 "healthy_nodes":"3",
 "labels":"",
 "tags":"",
 "kubernetes_config":"",
 "system_disk_category":"cloud_efficiency",
 "rds_instances":"rm-xxx",
 "cpu_policy":"none",
 "name":"default-nodepool",
 "min_instances":"1",
 "total_nodes":"3",
 "image_id":"aliyun_2_1903_x64_20G_alibase_20200529.vhd",
 "initial_nodes":"0",
 "nodepool_id":"np615c0e0966124216a0412e10afe0",
 "updated":"2020-09-27T20:37:46+08:00",
 "failed_nodes":"0",
 "scaling_policy":"release",
 "status":""
}

Failed Response example

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

}