|
Parameter |
Type |
Description |
Example |
|---|---|---|---|
|
object |
The node pool. |
||
| auto_scaling |
object |
The auto scaling configuration of the node pool. |
|
| enable |
boolean |
Specifies whether to enable auto scaling.
Default value: |
true |
| max_instances |
integer |
The maximum number of instances in the auto scaling group. |
10 |
| min_instances |
integer |
The minimum number of instances in the auto scaling group. |
0 |
| type |
string |
The auto scaling type, classified by instance type. Valid values:
Default value: |
cpu |
| is_bond_eip |
boolean |
[This field is deprecated] Specifies whether to associate an EIP. Valid values:
Default value: |
true |
| eip_internet_charge_type |
string |
[This field is deprecated] The billing method of the EIP. Valid values:
Default value: PayByBandwidth. |
PayByBandwidth |
| eip_bandwidth |
integer |
[This field is deprecated] The peak bandwidth of the EIP. Unit: Mbit/s. |
5 |
| kubernetes_config |
object |
The cluster-related configuration. |
|
| cms_enabled |
boolean |
Specifies whether to install the CloudMonitor agent on ECS nodes. After installation, you can view monitoring information of the created ECS instances in the CloudMonitor console. We recommend that you enable this feature. Valid values:
Default value: |
true |
| cpu_policy |
string |
The CPU management policy for nodes. The following two policies are supported for clusters of version 1.12.6 or later:
Default value: |
none |
| labels |
array |
The node labels. Adds labels to Kubernetes cluster nodes. |
|
| tag |
The node label. |
||
| runtime |
string |
The container runtime. Valid values:
Default value: |
containerd |
| runtime_version |
string |
The container runtime version. |
1.6.20 |
| taints |
array |
The taint configurations. |
|
| taint |
The taint configurations. |
||
| user_data |
string |
The node custom data. |
MXM= |
| node_name_mode |
string |
The node name consists of three parts: prefix + node IP + suffix:
The parameter contains four parts separated by commas. For example, if you pass in the string "customized,aliyun,ip,com" (where "customized" and "ip" are fixed strings, "aliyun" is the prefix, and "com" is the suffix), the node name is: aliyun.192.168.xxx.xxx.com. |
customized,aliyun,ip,com |
| nodepool_info |
object |
The node pool configuration. |
|
| name |
string |
The node pool name. |
np-test |
| resource_group_id |
string |
The resource group ID of the node pool. |
rg-acfmyvw3wjm**** |
| type |
string |
The node pool type. Valid values:
|
ess |
| scaling_group |
object |
The scaling group configuration of the node pool. |
|
| auto_renew |
boolean |
Specifies whether to enable auto-renewal for the node pool. This parameter takes effect only when
Default value: |
false |
| auto_renew_period |
integer |
The auto-renewal period of the node pool. This parameter takes effect and is required only when When Default value: 1. |
0 |
| data_disks |
array |
The data cloud disk configurations for nodes in the node pool. |
|
| data_disk |
The data cloud disk configurations for nodes in the node pool. |
||
| disk_init |
array |
The block device initialization configuration. |
|
|
DiskInit |
The DiskInit configuration. |
||
| image_id |
string |
The custom image ID. The system-provided image is used by default. |
aliyun_2_1903_x64_20G_alibase_20200904.vhd |
| instance_charge_type |
string |
The billing method for nodes in the node pool. Valid values:
Default value: |
PostPaid |
| instance_types |
array |
The instance types. |
|
|
string |
The instance types. |
ecs.n1.medium |
|
| key_pair |
string |
The key pair name. Choose either this or Note
If you create a managed node pool, only |
np-key |
| login_password |
string |
The SSH logon password. Choose either this or |
Hello1234 |
| login_as_non_root |
boolean |
Specifies whether the scaled-out ECS instance uses a non-root user for logon. |
|
| period |
integer |
The subscription duration for nodes in the node pool. This parameter takes effect and is required only when Default value: 1. |
0 |
| period_unit |
string |
The subscription period unit for nodes in the node pool. This parameter must be specified when
|
Month |
| platform |
string |
The operating system distribution. Valid values:
Default value: |
AliyunLinux |
| rds_instances |
array |
The list of RDS instances. |
|
|
string |
The RDS instance ID. |
rm-2zey3t89t6280**** |
|
| spot_strategy |
string |
The type of spot instance. Valid values:
For more information, see Spot instances. |
NoSpot |
| spot_price_limit |
array |
The market price range configuration for a single spot instance type. |
|
|
object |
|||
| instance_type |
string |
The spot instance type. |
ecs.c6.large |
| price_limit |
string |
The maximum price for a single instance. |
0.39 |
| scaling_policy |
string |
The scaling group mode. Valid values:
Default value: |
release |
| security_group_id |
string |
The security group ID of the node pool. Choose either this or |
sg-2zeihch86ooz9io4**** |
| security_group_ids |
array |
The list of security group IDs. Choose either this or |
|
|
string |
The security group ID. |
sg-2zeihch86ooz9io4**** |
|
| system_disk_category |
string |
The system cloud disk type for nodes. Valid values:
Default value: |
cloud_efficiency |
| system_disk_categories |
array |
Multiple cloud disk types for the system cloud disk. When the highest-priority cloud disk type is unavailable, the system automatically attempts the next-priority cloud disk type to create the system cloud disk. Valid values:
|
|
|
string |
The node system cloud disk type. |
cloud_essd |
|
| system_disk_size |
integer |
The node system cloud disk size. Unit: GiB. Valid values: [40,500]. |
120 |
| system_disk_performance_level |
string |
The performance level of the node system cloud disk. Only applies to ESSD cloud disks.
|
PL1 |
| system_disk_encrypted |
boolean |
Specifies whether to encrypt the system cloud disk. Valid values: true: Encrypted. false: Not encrypted. |
|
| system_disk_kms_key_id |
string |
The KMS key ID used for the node system cloud disk. |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| system_disk_encrypt_algorithm |
string |
The encryption algorithm used for the node system cloud disk. Valid values: aes-256. |
aes-256 |
| system_disk_provisioned_iops |
integer |
The provisioned read/write IOPS for the node system cloud disk. Valid values: 0~min{50,000, 1000*capacity-baseline performance}. Baseline performance=min{1,800+50*capacity, 50000}. This parameter is supported only when |
1000 |
| system_disk_bursting_enabled |
boolean |
Specifies whether to enable burst (performance bursting) for the node system cloud disk. Valid values:
This parameter is supported only when |
true |
| tags |
array |
Adds tags only to ECS instances. Tag keys cannot be duplicated and can be up to 128 characters in length. Tag keys and tag values cannot start with "aliyun" or "acs:", or contain "https://" or "http://". |
|
|
object |
|||
| key |
string |
The tag key. |
key |
| value |
string |
The tag value. |
value |
| vswitch_ids |
array |
The vSwitch IDs. |
|
|
string |
The vSwitch IDs. |
vsw-2ze0fmpbwo140ahni**** |
|
| multi_az_policy |
string |
The multi-zone scaling policy for ECS instances in the scaling group. Valid values:
Default value: |
COST_OPTIMIZED |
| on_demand_base_capacity |
integer |
The minimum number of pay-as-you-go instances required in the scaling group. Valid values: [0,1000]. When the number of pay-as-you-go instances is less than this value, pay-as-you-go instances are created first. |
0 |
| on_demand_percentage_above_base_capacity |
integer |
The percentage of pay-as-you-go instances among the instances that exceed the minimum number of pay-as-you-go instances ( |
20 |
| spot_instance_pools |
integer |
The number of available instance types. The scaling group creates spot instances across the lowest-cost instance types in a balanced manner. Valid values: [1,10]. |
5 |
| spot_instance_remedy |
boolean |
Specifies whether to enable supplementing spot instances. When enabled, the scaling group attempts to create new instances to replace spot instances that are about to be reclaimed upon receiving a system notification. Valid values:
|
false |
| compensate_with_on_demand |
boolean |
When
|
true |
| internet_charge_type |
string |
The billing method for public IP addresses. Valid values:
|
PayByBandwidth |
| internet_max_bandwidth_out |
integer |
The maximum outbound bandwidth for node public IP addresses. Unit: Mbit/s. Valid values: [1,100]. |
10 |
| image_type |
string |
The operating system image type. Choose either this or the platform parameter. Valid values:
|
AliyunLinux |
| deploymentset_id |
string |
The deployment set ID. |
ds-bp1d19mmbsv3jf6xxxxx |
| desired_size |
integer |
The desired number of nodes in the node pool. |
2 |
| private_pool_options |
object |
The private pool configuration. |
|
| id |
string |
The private pool ID. |
eap-bp67acfmxazb4**** |
| match_criteria |
string |
The private pool type. The private pool capacity option for instance launch. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for instance launch. Valid values:
|
Open |
| ram_role_name |
string |
The Worker RAM role name. Important Only ACK managed clusters of version 1.22 or later support configuring this parameter when creating a node pool. |
example-role |
| instance_metadata_options | InstanceMetadataOptions |
The ECS instance metadata access configuration. Currently available only through a whitelist. Submit a ticket to apply. |
|
| resource_pool_options |
object |
The resource pool and resource pool policy used when creating instances. Note the following when you set this parameter: This parameter takes effect only when creating pay-as-you-go instances. This parameter cannot be set together with private_pool_options.match_criteria or private_pool_options.id. |
|
| strategy |
string |
The resource pool policy used when creating instances. Resource pools include private pools generated after elasticity assurance or capacity reservation takes effect, and public pools, for instance launch. Valid values: PrivatePoolFirst: private pool first. When this strategy is selected and resource_pool_options.private_pool_ids is specified, the specified private pools are used first. If no private pool is specified or the specified private pool capacity is insufficient, open-type private pools are automatically matched. If no matching private pool is available, public pool is used to create instances. PrivatePoolOnly: private pool only. When this strategy is selected, resource_pool_options.private_pool_ids must be specified. If the specified private pool capacity is insufficient, the instance fails to launch. None: no resource pool policy. Default value: None. |
PrivatePoolFirst |
| private_pool_ids |
array |
The list of private pool IDs, which are elasticity assurance IDs or capacity reservation IDs. Only Target mode private pool IDs can be passed in. Valid values of N: 1 to 20. |
|
|
string |
The private pool ID, which is an elasticity assurance ID or capacity reservation ID. Only Target mode private pool IDs can be passed in. |
eap-bp67acfmxazb4**** |
|
| tee_config |
object |
The confidential computing node pool configuration. |
|
| tee_enable |
boolean |
Specifies whether this is a confidential computing node pool. |
false |
| management |
object |
The managed node pool configuration. |
|
| enable |
boolean |
Specifies whether to enable the managed node pool. Valid values:
|
false |
| auto_repair |
boolean |
Specifies whether to enable auto repair. Takes effect only when
|
false |
| upgrade_config |
object |
The auto upgrade configuration. Takes effect only when |
|
| auto_upgrade |
boolean |
Specifies whether to enable auto upgrade. Valid values:
|
false |
| surge |
integer |
The number of extra nodes. |
0 |
| surge_percentage |
integer |
The extra node percentage. Choose either this or |
0 |
| max_unavailable |
integer |
The maximum number of unavailable nodes. Valid values: [1,1000]. Default value: 1. |
0 |
| auto_repair_policy |
object |
The auto repair node policy. |
|
| restart_node |
boolean |
Specifies whether to allow node restart. |
true |
| auto_vul_fix |
boolean |
Specifies whether to enable automatic CVE fix. |
true |
| auto_vul_fix_policy |
object |
自动修复 CVE 策略。 |
|
| restart_node |
boolean |
Specifies whether to allow node restart. |
true |
| vul_level |
string |
允许自动修复的漏洞级别,以逗号分隔。 |
asap,nntf |
| auto_upgrade |
boolean |
是否自动升级。 |
true |
| auto_upgrade_policy |
object |
自动升级策略。 |
|
| auto_upgrade_kubelet |
boolean |
是否允许自动升级 kubelet。 |
true |
| auto_fault_diagnosis |
boolean |
||
| drift_enabled |
boolean |
||
| count |
integer |
[This field is deprecated. Use desired_size instead.] The number of nodes in the node pool. |
1 |
| interconnect_mode |
string |
The network type of the edge node pool. This value is valid only for node pools whose
|
basic |
| interconnect_config |
object |
[This field is deprecated.] The edge node pool configuration. |
|
| cen_id |
string |
【该字段已废弃】 边缘增强型节点池绑定的云企业网实例 ID(CENID)。 |
cen-ey9k9nfhz0f******* |
| ccn_id |
string |
【该字段已废弃】 边缘增强型节点池绑定的云连接网实例 ID(CCNID)。 |
ccn-qm5i0i0q9yi******* |
| ccn_region_id |
string |
【该字段已废弃】 边缘增强型节点池绑定的云连接网实例所属的地域。 |
cn-shanghai |
| bandwidth |
integer |
【该字段已废弃】 边缘增强型节点池的网络带宽,单位:Mbps。 |
10 |
| improved_period |
string |
【该字段已废弃】 边缘增强型节点池的购买时长,单位:月。 |
1 |
| max_nodes |
integer |
The maximum number of nodes allowed in the edge node pool. This parameter must be greater than or equal to 0. A value of 0 indicates no additional limit (the node pool is limited only by the maximum number of nodes that the cluster can accommodate). For edge node pools, this value is typically greater than 0. For ESS-type node pools and default edge-type node pools, this value is 0. |
10 |
| node_config |
object |
The node configuration. |
|
| kubelet_configuration | kubelet_config |
Kubelet 参数配置。 |
|
| node_components |
array |
The list of node components. |
|
|
object |
节点组件。 |
||
| name |
string |
节点组件名称。 |
kubelet |
| version |
string |
节点组件版本 |
1.33.3-aliyun.1 |
| config |
object |
节点组件配置。 |
|
| custom_config |
object |
节点组件自定义配置。 |
{"cpuManagerPolicy":"static"} |
|
any |
节点组件自定义配置字符串。 |
cpuManagerPolicy |