| object | The details of the node pool. | |
nodepool_info | object | The configuration of the node pool. | |
nodepool_id | string | | np615c0e0966124216a0412e10afe0**** |
name | string | The name of the node pool.
The name must be 1 to 63 characters in length, and can contain digits, letters, and hyphens (-). It cannot start with a hyphen (-). | default-nodepool |
type | string | | ess |
is_default | boolean | Indicates whether the node pool is a default node pool. A Container Service for Kubernetes (ACK) cluster usually has only one default node pool. Valid values: true : The node pool is a default node pool. false : The node pool is not a default node pool. | true |
resource_group_id | string | The ID of the resource group. | rg-acfmyvw3wjmb**** |
region_id | string | | cn-beijing |
created | string | The time when the node pool was created. | 2020-09-27T19:14:09.156823496+08:00 |
updated | string | The time when the node pool was last updated. | 2020-09-27T20:37:46+08:00 |
status | object | The status details about the node pool. | |
state | string | The status of the node pool. Valid values:
active : The node pool is active.
scaling : The node pool is being scaled.
removing : Nodes are being removed from the node pool.
deleting : The node pool is being deleted.
updating : The node pool is being updated.
| active |
healthy_nodes | long | The number of healthy nodes. | 3 |
initial_nodes | long | The number of nodes that are being created. | 0 |
failed_nodes | long | The number of failed nodes. | 0 |
offline_nodes | long | The number of offline nodes. | 0 |
removing_nodes | long | The number of nodes that are being removed. | 0 |
serving_nodes | long | The number of running nodes. | 3 |
total_nodes | long | The total number of nodes in the node pool. | 3 |
auto_scaling | object | The auto scaling configuration of the node pool. | |
enable | boolean | Indicates whether auto scaling is enabled. Valid values:
true : auto scaling is enabled.
false : auto scaling is disabled. If this parameter is set to false, other parameters in the auto_scaling section do not take effect.
| true |
type | string | The instance types that can be used for the auto scaling of the node pool. Valid values:
cpu : regular instance.
gpu : GPU-accelerated instance.
gpushare : shared GPU-accelerated instance.
spot : preemptible instance.
| cpu |
max_instances | long | The maximum number of Elastic Compute Service (ECS) instances that can be created in the node pool. | 10 |
min_instances | long | The minimum number of ECS instances that must be kept in the node pool. | 1 |
eip_internet_charge_type | string | The metering method of the EIP. Valid values:
PayByBandwidth : pay-by-bandwidth.
PayByTraffic : pay-by-data-transfer.
| PayByBandwidth |
is_bond_eip | boolean | Indicates whether an EIP is associated with the node pool. Valid values:
true : An EIP is associated with the node pool.
false : No EIP is associated with the node pool.
| true |
eip_bandwidth | long | The maximum bandwidth of the elastic IP address (EIP). | 5 |
management | object | The configuration of the managed node pool feature. | |
enable | boolean | Indicates whether the managed node pool feature is enabled. Valid values:
true : The managed node pool feature is enabled.
false : The managed node pool feature is disabled. Other parameters in this section take effect only when enable=true is specified.
| true |
auto_repair | boolean | Indicates whether auto repair is enabled. This parameter takes effect only when enable=true is specified. Valid values:
true : Auto repair is enabled.
false : Auto repair is disabled.
| true |
auto_repair_policy | object | Automatic repair node policy. | |
restart_node | boolean | Whether to allow restarting nodes. | true |
auto_vul_fix | boolean | Whether to automatically fix CVEs. | true |
auto_vul_fix_policy | object | Automatically repair CVE policies. | |
restart_node | boolean | Whether to allow restarting nodes. | true |
vul_level | string | The vulnerability levels allowed for auto-fixing, separated by commas. | asap,nntf |
auto_upgrade | boolean | Whether to automatically upgrade. | true |
auto_upgrade_policy | object | Automatic upgrade policy. | |
auto_upgrade_kubelet | boolean | Whether to allow automatic upgrading of kubelet. | true |
upgrade_config | object | The configuration of auto update. The configuration takes effect only when enable=true is specified. | |
auto_upgrade | boolean | Indicates whether auto update is enabled. Valid values:
true : Auto update is enabled.
false : Auto update is disabled.
| true |
surge | long | The number of additional nodes. | 5 |
surge_percentage | long | The percentage of additional nodes to the nodes in the node pool. You must set this parameter or surge . | 50 |
max_unavailable | long | The maximum number of nodes that can be in the Unavailable state. Valid values: 1 to 1000.
Default value: 1. | 1 |
scaling_group | object | The configurations of the scaling group. | |
scaling_group_id | string | The ID of the scaling group. | asg-2zeieod8giqmov7z**** |
vswitch_ids | array | The IDs of vSwitches. You can specify 1 to 20 vSwitches.
Note
We recommend that you select vSwitches in different zones to ensure high availability.
| |
vswitch_ids | string | | vsw-2ze3ds0mdip0hdz8i**** |
instance_types | array | A list of instance types. You can select multiple instance types. When the system needs to create a node, it starts from the first instance type until the node is created. The instance type that is used to create the node varies based on the actual instance stock. | |
instance_types | string | The instance types of the nodes in the node pool. | ecs.n4.large |
instance_charge_type | string | The billing method of the nodes in the node pool. Valid values:
PrePaid : the subscription billing method.
PostPaid : the pay-as-you-go billing method.
| PostPaid |
period | long | The subscription duration of worker nodes. This parameter takes effect and is required only when instance_charge_type is set to PrePaid .
If PeriodUnit=Month is specified, the valid values are 1, 2, 3, 6, 12, 24, 36, 48, and 60. | 0 |
period_unit | string | The billing cycle of the nodes. This parameter is required if instance_charge_type is set to PrePaid .
Valid value: Month . | Month |
auto_renew | boolean | Indicates whether auto-renewal is enabled for the nodes in the node pool. This parameter takes effect only when instance_charge_type is set to PrePaid . Valid values:
true : Auto-renewal is enabled.
false : Auto-renewal is disabled.
| false |
auto_renew_period | long | The duration of the auto-renewal. This parameter takes effect and is required only when instance_charge_type is set to PrePaid .
If you specify PeriodUnit=Month , the valid values are 1, 2, 3, 6, and 12. | 1 |
spot_strategy | string | The type of preemptible instance. Valid values:
- NoSpot: a non-preemptible instance.
- SpotWithPriceLimit: a preemptible instance that is configured with the highest bid price.
- SpotAsPriceGo: a preemptible instance for which the system automatically bids based on the current market price.
For more information, see Preemptible instances. | NoSpot |
spot_price_limit | array<object> | The bid configurations of preemptible instances. | |
spot_price_limit | object | Spot instance market price range configuration, allowing different price ranges to be set for various instance types. | |
instance_type | string | The instance type of the preemptible instances. | ecs.c6.large |
price_limit | string | The price cap of a preemptible instance of the type.
Unit: USD/hour. | 0.39 |
image_type | string | Operating system image type. | AliyunLinux |
image_id | string | The ID of the custom image. You can call the DescribeKubernetesVersionMetadata operation to query the images supported by ACK. | aliyun_2_1903_x64_20G_alibase_20200529.vhd |
system_disk_category | string | The system disk type. Valid values:
cloud : basic disk
cloud_efficiency : ultra disk
cloud_ssd : standard SSD
cloud_essd : Enterprise SSD (ESSD)
cloud_auto : ESSD AutoPL disk
cloud_essd_entry : ESSD Entry disk
Default value: cloud_efficiency . | cloud_efficiency |
system_disk_categories | array | The system disk types. The system attempts to create system disks from a disk type with a lower priority when the disk type with a higher priority is unavailable. Valid values: Valid values:
cloud : basic disk
cloud_efficiency : ultra disk
cloud_ssd : standard SSD
cloud_essd : ESSD
cloud_auto : ESSD AutoPL disk
cloud_essd_entry : ESSD Entry disk
Default value: cloud_efficiency . | |
system_disk_categories | string | | cloud_essd |
system_disk_size | long | The system disk size of a node. Unit: GiB.
Valid values: 20 to 500. | 120 |
system_disk_performance_level | string | The performance level (PL) of the system disk that you want to use for the node. This parameter takes effect only for enhanced SSDs (ESSDs). | PL1 |
system_disk_encrypted | boolean | Specifies whether to encrypt the system disk. Valid values: Valid values:
true : encrypts the system disk.
false : does not encrypt the system disk.
| false |
system_disk_kms_key_id | string | System disk's KMS key ID. | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
system_disk_encrypt_algorithm | string | Encryption algorithm used for the system disk. Valid values: aes-256. | aes-256 |
system_disk_bursting_enabled | boolean | Whether to enable Burst (performance burst) for the node system disk, configured when the disk type is cloud_auto. | true |
system_disk_provisioned_iops | long | Pre-configured read and write IOPS for the system disk of the node, configured when the disk type is cloud_auto. | 1000 |
data_disks | array | The configurations of the data disks that are attached to the nodes in the node pool. The configurations include the disk type and disk size. | |
data_disks | data_disk | Configurations of node data disks. | |
security_group_ids | array | The IDs of the security groups to which the node pool is added. | |
security_group_ids | string | The IDs of the security groups to which the node pool is added. | sg-2ze60ockeekspl3d**** |
key_pair | string | The name of the key pair. You must set this parameter or the login_password parameter. You must set key_pair if the node pool is a managed node pool. | pro-nodepool |
login_password | string | The password for SSH logon. You must set this parameter or the key_pair parameter. The password must be 8 to 30 characters in length, and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
For security purposes, the returned password is encrypted. | ******** |
login_as_non_root | boolean | Whether the popped ECS instance uses a non-root user for login. | true |
cis_enableddeprecated | boolean | 【The field is deprecated】Please use the parameter security_hardening_os instead. | false |
soc_enabled | boolean | Indicates whether to enable security reinforcement compliant with the hardening standards. This option is available only when the system image is set to Alibaba Cloud Linux 2 or Alibaba Cloud Linux 3. Alibaba Cloud provides baseline check standards and scanning programs compliant with Grade 3, Version 2.0 of the hardening standards for both Alibaba Cloud Linux 2 and Alibaba Cloud Linux 3 images. | false |
security_hardening_os | boolean | Alibaba Cloud OS security hardening. Values:
true : Enable Alibaba Cloud OS security hardening.
false : Do not enable Alibaba Cloud OS security hardening.
Default value: false . | false |
internet_charge_type | string | The billing method of the public IP address of the node. | PayByBandwidth |
internet_max_bandwidth_out | long | The maximum outbound bandwidth of the public IP address of the node. Unit: Mbit/s. Valid values: 1 to 100. | 10 |
tags | array | The labels that you want to add to the ECS instances.
A key must be unique and cannot exceed 128 characters in length. Neither keys nor values can start with aliyun or acs:. Neither keys nor values can contain https:// or http://. | |
tags | tag | The labels that you want to add to nodes. | |
desired_size | long | The expected number of nodes in the node pool. | 2 |
multi_az_policy | string | The ECS instance scaling policy for a multi-zone scaling group. Valid values:
-
PRIORITY : the scaling group is scaled based on the VSwitchIds.N parameter. If an ECS instance cannot be created in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates the ECS instance in the zone where the vSwitch that has the next highest priority resides.
-
COST_OPTIMIZED : ECS instances are created based on the vCPU unit price in ascending order. Preemptible instances are preferably created when preemptible instance types are specified in the scaling configuration. You can set the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient resources.
**
NoteThe COST_OPTIMIZED setting takes effect only when multiple instance types are specified or at least one instance type is specified for preemptible instances.
-
BALANCE : ECS instances are evenly distributed across multiple zones specified by the scaling group. If ECS instances become imbalanced among multiple zones due to insufficient inventory, you can call the RebalanceInstances operation of Auto Scaling to balance the instance distribution among zones. For more information, see RebalanceInstances .
Default value: PRIORITY . | BALANCE |
scaling_policy | string | The scaling mode of the scaling group. Valid values:
release : the standard mode. ECS instances are created and released based on resource usage.
recycle : the swift mode. ECS instances are created, stopped, or started during scaling events. This reduces the time required for the next scale-out event. When the instance is stopped, you are charged only for the storage service. This does not apply to ECS instances that are attached with local disks.
| release |
on_demand_base_capacity | long | The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances. | 0 |
on_demand_percentage_above_base_capacity | long | The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by on_demand_base_capacity . Valid values: 0 to 100. | 20 |
spot_instance_pools | long | The number of instance types that are available for creating preemptible instances. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10. | 5 |
spot_instance_remedy | boolean | Indicates whether preemptible instances are supplemented when the number of preemptible instances drops below the specified minimum number. If this parameter is set to true, when the scaling group receives a system message that a preemptible instance is to be reclaimed, the scaling group attempts to create a new instance to replace this instance. Valid values: Valid values:
true : Supplementation of preemptible instances is enabled.
false : Supplementation of preemptible instances is disabled.
| false |
compensate_with_on_demand | boolean | Indicates whether pay-as-you-go instances are automatically created to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when multi_az_policy is set to COST_OPTIMIZED . Valid values:
true : Pay-as-you-go instances are automatically created to meet the required number of ECS instances if preemptible instances cannot be created.
false : Pay-as-you-go instances are not automatically created to meet the required number of ECS instances if preemptible instances cannot be created.
| true |
deploymentset_id | string | The ID of the deployment set to which the ECS instances in the node pool belong. | ds-bp1d19mmbsv3jf6xxxxx |
rds_instances | array | After you specify the list of RDS instances, the ECS instances in the cluster are automatically added to the whitelist of the RDS instances. | |
rds_instance | string | The ApsaraDB RDS instance. | rm-xxx |
private_pool_options | object | The configuration of the private node pool. | |
id | string | The ID of the private node pool. | eap-bp67acfmxazb4**** |
match_criteria | string | The type of private node pool. This parameter specifies the type of private node pool that you want to use to create instances. A private node pool is generated when an elasticity assurance or a capacity reservation service takes effect. The system selects a private node pool to launch instances. Valid values:
Open : open private pool. The system selects an open private node pool to launch instances. If no matching open private node pool is available, the resources in the public node pool are used.
Target : specific private pool. The system uses the resources of the specified private node pool to launch instances. If the specified private node pool is unavailable, instances cannot be launched.
None : no private node pool is used. The resources of private node pools are not used to launch the instances.
| Open |
security_group_id | string | The ID of the security group to which the node pool is added. If the node pool is added to multiple security groups, the first ID in the value of security_group_ids is returned. | sg-2ze60ockeekspl3d**** |
platform | string | The release version of the operating system. Valid values:
CentOS
AliyunLinux
Windows
WindowsCore
| AliyunLinux |
ram_policy | string | The name of the worker Resource Access Management (RAM) role. The RAM role is assigned to the worker nodes of the cluster to allow the worker nodes to manage ECS instances. | KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e**** |
instance_patterns | array | | |
instance_pattern | instance_patterns | | |
ram_role_name | string | | KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f**** |
node_config | object | | |
kubelet_configuration | kubelet_config | Kubelet parameter configuration. | |
kubernetes_config | object | The configurations of the cluster in which the node pool is deployed. | |
labels | array | The labels of the nodes in the node pool. You can add labels to the nodes in the cluster. You must add labels based on the following rules:
- Each label is a case-sensitive key-value pair. You can add up to 20 labels.
- A key must be unique and cannot exceed 64 characters in length. A value can be empty and cannot exceed 128 characters in length. Keys and values cannot start with
aliyun , acs: , https:// , or http:// . For more information, see Labels and Selectors.
| |
label | tag | The label to be added to the ECS instances. | |
taints | array | The taints of the nodes in the node pool. Taints are added to nodes to prevent pods from being scheduled to inappropriate nodes. However, tolerations allow pods to be scheduled to nodes with matching taints. For more information, see taint-and-toleration. | |
taints | taint | The configurations of node taints. | |
runtime | string | The name of the container runtime. | docker |
runtime_version | string | The version of the container runtime. | 19.03.5 |
cpu_policy | string | The CPU management policy of the nodes in the node pool. The following policies are supported if the Kubernetes version of the cluster is 1.12.6 or later.
static : allows pods with specific resource characteristics on the node to be granted enhanced CPU affinity and exclusivity.
none : indicates that the default CPU affinity is used.
| none |
user_data | string | The custom script to be executed after nodes in the node pool are initialized. For more information, see Generate user-defined data. | IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi |
unschedulable | boolean | Whether the expanded node is schedulable. | true |
cms_enabled | boolean | Indicates whether the CloudMonitor agent is installed on ECS nodes in the cluster. After the CloudMonitor agent is installed, you can view monitoring information about the ECS instances in the CloudMonitor console. Installation is recommended. Valid values:
true : The CloudMonitor agent is installed on ECS nodes.
false : The CloudMonitor agent is not installed on ECS nodes.
| true |
node_name_mode | string | A custom node name consists of a prefix, an IP substring, and a suffix.
- The prefix and suffix can contain multiple parts that are separated by periods (.). Each part can contain lowercase letters, digits, and hyphens (-). A custom node name must start and end with a digit or lowercase letter.
- The IP substring length specifies the number of digits to be truncated from the end of the node IP address. The IP substring length ranges from 5 to 12.
For example, if the node IP address is 192.168.0.55, the prefix is aliyun.com, the IP substring length is 5, and the suffix is test, the node name will be aliyun.com00055test. | customized,test.,5,.com |
pre_user_data | string | The custom script to be executed before nodes in the node pool are initialized. For more information, see Generate user-defined data. | |
tee_config | object | The configuration of confidential computing. | |
tee_enable | boolean | Indicates whether confidential computing is enabled. Valid values:
true : Confidential computing is enabled.
false : Confidential computing is disabled.
| false |
interconnect_config | object | The network configuration of the edge node pool. This parameter takes effect only for edge node pools. | |
cen_id | string | The ID of the Cloud Enterprise Network (CEN) instance that is associated with the enhanced edge node pool. | cen-ey9k9nfhz0f******* |
ccn_id | string | The ID of the Cloud Connect Network (CCN) instance that is associated with the enhanced edge node pool. | ccn-qm5i0i0q9yi******* |
ccn_region_id | string | The region to which the CCN instance that is associated with the enhanced edge node pool belongs. | cn-shanghai |
bandwidth | long | The bandwidth of the enhanced edge node pool. Unit: Mbit/s. | 10 |
improved_period | string | The subscription duration of the enhanced edge node pool. The duration is measured in months. | 1 |
max_nodes | long | The maximum number of nodes that are supported by the edge node pool. The value of this parameter must be equal to or greater than 0. A value of 0 indicates that the number of nodes in the node pool is limited only by the quota of nodes in the cluster. In most cases, this parameter is set to a value larger than 0 for edge node pools. This parameter is set to 0 for node pools whose types are ess or default edge node pools. | 10 |
interconnect_mode | string | The network type of the edge node pool. Valid values: basic and enhanced. This parameter takes effect only for edge node pools. | improved |