文档

nodepool

更新时间:
名称类型描述示例值
object

节点池。

auto_scalingobject

自动伸缩节点池配置。

enableboolean

是否启用自动伸缩。

  • true:开启节点池自动伸缩功能。
  • false:不开启自动伸缩,当取值为 false 时,auto_scaling内的其他配置参数将不生效。

默认值:false

true
max_instanceslong

自动伸缩组最大实例数。

10
min_instanceslong

自动伸缩组最小实例数。

0
typestring

自动伸缩类型,按照自动伸缩实例类型划分。取值:

  • cpu:普通实例型。
  • gpu:GPU 实例型。
  • gpushare:GPU 共享型。
  • spot:抢占式实例型。

默认值:cpu

cpu
is_bond_eipboolean

【该字段已废弃】

是否绑定 EIP,取值:

  • true:绑定 EIP。
  • false:不绑定 EIP。

默认值:false

true
eip_internet_charge_typestring

【该字段已废弃】

EIP 计费类型,取值:

  • PayByBandwidth:按固定带宽计费。
  • PayByTraffic:按使用流量计费。

默认值:PayByBandwidth。

PayByBandwidth
eip_bandwidthlong

【该字段已废弃】

EIP 带宽峰值。单位:Mbps。

5
kubernetes_configobject

集群相关配置。

cms_enabledboolean

是否在 ECS 节点上安装云监控,安装后可以在云监控控制台查看所创建 ECS 实例的监控信息,推荐开启。取值:

  • true:在 ECS 节点上安装云监控。
  • false:不在 ECS 节点上安装云监控。

默认值:false

true
cpu_policystring

节点 CPU 管理策略。当集群版本在 1.12.6 及以上时支持以下两种策略:

  • static:允许为节点上具有某些资源特征 Pod 增强其 CPU 亲和性和独占性。
  • none:表示启用现有的默认 CPU 亲和性方案。

默认值:none

none
labelsarray

节点标签,为 Kubernetes 集群节点添加标签。

tag

节点标签。

runtimestring

容器运行时。取值:

  • containerd:推荐使用,支持所有集群版本。
  • Sandboxed-Container.runv:安全沙箱容器,提供更高的隔离性,支持 1.24 版本及以下集群。
  • docker:支持 1.22 版本及以下集群。

默认值:containerd

containerd
runtime_versionstring

容器运行时版本。

1.6.20
taintsarray

污点配置。

taint

污点配置。

user_datastring

节点自定义数据。

MXM=
node_name_modestring

节点名称由三部分组成:前缀 + 节点 IP + 后缀:

  • 前缀和后缀均可由“.”分隔的一个或多个部分构成,每个部分可以使用小写字母、数字和“-”,节点名称首尾必须为小写字母和数字;
  • 节点 IP 为完整的节点私网 IP 地址;

传参包含四个部分,由逗号分隔,例如:参数传入"customized,aliyun,ip,com"字符串(其中“customized”和"ip"为固定的字符串,aliyun 为前缀,com 为后缀),则节点的名称为:aliyun.192.168.xxx.xxx.com。

customized,aliyun,ip,com
nodepool_infoobject

节点池配置。

namestring

节点池名称。

np-test
resource_group_idstring

节点池所在资源 ID。

rg-acfmyvw3wjm****
typestring

节点池类型,取值范围:

  • ess:节点池。
  • edge:边缘节点池。
ess
scaling_groupobject

节点池扩容组配置。

auto_renewboolean

节点池是否开启自动续费,当instance_charge_type取值为PrePaid时才生效,取值:

  • true:自动续费。
  • false:不自动续费。

默认值:true

false
auto_renew_periodlong

节点池自动续费周期。当instance_charge_type取值为PrePaid时才生效,且为必选值。

PeriodUnit=Month时,取值范围:{1, 2, 3, 6, 12}。

默认值:1。

0
data_disksarray

节点池节点数据盘配置。

data_disk

节点池节点数据盘配置。

image_idstring

自定义镜像 ID,默认使用系统提供的镜像。

aliyun_2_1903_x64_20G_alibase_20200904.vhd
instance_charge_typestring

节点池节点付费类型,取值:

  • PrePaid:预付费。
  • PostPaid:按量付费。

默认值:PostPaid

PostPaid
instance_typesarray

实例规格。

string

实例规格。

ecs.n1.medium
key_pairstring

密钥对名称,和login_password二选一。

说明 如果创建托管节点池,则只支持key_pair
np-key
login_passwordstring

SSH 登录密码,和key_pair二选一。密码规则为 8~30 个字符,且至少同时包含三项(大小写字母、数字和特殊符号)。

Hello1234
login_as_non_rootboolean

弹出的 ECS 实例是否使用以非 root 用户登录。

periodlong

节点池节点包年包月时长,当instance_charge_type取值为PrePaid时才生效且为必选值,取值范围:period_unit取值为 Month 时,period取值范围:{ 1, 2, 3, 6, 12}。

默认值:1。

0
period_unitstring

节点池节点付费周期,当instance_charge_type取值为PrePaid时需要指定周期。

Month:目前只支持以月为单位。

Month
platformstring

操作系统发行版。取值:

  • CentOS
  • AliyunLinux
  • Windows
  • WindowsCore

默认值:AliyunLinux

AliyunLinux
rds_instancesarray

RDS 实例列表。

string

RDS 实例 ID。

rm-2zey3t89t6280****
spot_strategystring

抢占式实例类型,取值:

  • NoSpot:非抢占式实例。
  • SpotWithPriceLimit:设置抢占实例价格上限。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。

更多信息,请参见抢占式实例

NoSpot
spot_price_limitobject []

当前单台抢占式实例规格市场价格区间配置。

instance_typestring

抢占式实例规格。

ecs.c6.large
price_limitstring

单台实例上限价格。

0.39
scaling_policystring

伸缩组模式,取值:

  • release:标准模式,根据申请资源值的使用量,通过创建、释放 ECS 的方式进行伸缩。
  • recycle:极速模式,通过创建、停机、启动的方式进行伸缩,提高再次伸缩的速度(停机时计算资源不收费,只收取存储费用,本地盘机型除外)。

默认值:release

release
security_group_idstring

节点池安全组 ID,与security_group_ids二选一,推荐使用security_group_ids

sg-2zeihch86ooz9io4****
security_group_idsarray

安全组 ID 列表,与security_group_id二选一,推荐使用security_group_ids,当同时指定security_group_idsecurity_group_ids将优先使用security_group_ids

string

安全组 ID。

sg-2zeihch86ooz9io4****
system_disk_categorystring

节点系统盘类型,取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
  • cloud_auto:ESSD AutoPL 云盘。
  • cloud_essd_entry:ESSD Entry 云盘。

默认值:cloud_efficiency

cloud_efficiency
system_disk_categoriesarray

系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时,自动尝试下一优先级的磁盘类型创建系统盘。取值范围:cloud:普通云盘。cloud_efficiency:高效云盘。cloud_ssd:SSD 云盘。cloud_essd:ESSD 云盘。

string

节点系统盘类型

system_disk_sizelong

节点系统盘大小,单位:GiB。

取值范围:[40,500]。

120
system_disk_performance_levelstring

节点系统盘磁盘性能,只对 ESSD 磁盘生效。

  • PL0:并发极限 I/O 性能中等,读写时延较为稳定。
  • PL1:并发极限 I/O 性能中等,读写时延较为稳定。
  • PL2:并发极限 I/O 性能较高,读写时延稳定。
  • PL3:并发极限 I/O 性能极高,读写时延极稳定。
PL1
system_disk_encryptedboolean

是否加密系统盘。取值范围:true:加密。false:不加密。

system_disk_kms_key_idstring

节点系统盘使用的 KMS 密钥 ID。

0e478b7a-4262-4802-b8cb-00d3fb40****
system_disk_encrypt_algorithmstring

节点系统盘采用的加密算法。取值范围:aes-256。

aes-256
system_disk_provisioned_iopslong

节点系统盘预配置的读写 IOPS。可能值:0~min{50,000, 1000*容量-基准性能}。 基准性能=min{1,800+50*容量, 50000}。

SystemDiskCategorycloud_auto时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘

1000
system_disk_bursting_enabledboolean

节点系统盘是否开启 Burst(性能突发)。 取值:

  • true:是。
  • false:否。

SystemDiskCategory取值为cloud_auto时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘

true
tagsobject []

仅为 ECS 实例添加标签。

标签键不可以重复,最大长度为 128 个字符;标签键和标签值都不能以“aliyun”、“acs:”开头,或包含“https://”、“http://”。

keystring

标签的名称。

key
valuestring

标签值。

value
vswitch_idsarray

虚拟交换机 ID。

string

虚拟交换机 ID。

vsw-2ze0fmpbwo140ahni****
multi_az_policystring

多可用区伸缩组 ECS 实例扩缩容策略。取值:

  • PRIORITY:根据您定义的虚拟交换机(VSwitchIds.N)扩缩容。当优先级较高的虚拟交换机所在可用区无法创建 ECS 实例时,自动使用下一优先级的虚拟交换机创建 ECS 实例。

  • COST_OPTIMIZED:按 vCPU 单价从低到高进行尝试创建。当伸缩配置设置了抢占式计费方式的多实例规格时,优先创建对应抢占式实例。您可以继续通过CompensateWithOnDemand参数指定当抢占式实例由于库存等原因无法创建时,是否自动尝试以按量付费的方式创建。

    说明 COST_OPTIMIZED仅在伸缩配置设置了多实例规格或者选用了抢占式实例的情况下生效。
  • BALANCE:在伸缩组指定的多可用区之间均匀分配 ECS 实例。如果由于库存不足等原因可用区之间变得不平衡,您可以通过 API RebalanceInstances 平衡资源。更多信息,请参见 RebalanceInstances

默认值:PRIORITY

COST_OPTIMIZED
on_demand_base_capacitylong

伸缩组所需要按量实例个数的最小值,取值范围:[0,1000]。当按量实例个数少于该值时,将优先创建按量实例。

0
on_demand_percentage_above_base_capacitylong

伸缩组满足最小按量实例数(on_demand_base_capacity)要求后,超出的实例中按量实例应占的比例。取值范围:[0,100]。

20
spot_instance_poolslong

指定可用实例规格的个数,伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围:[1,10]。

5
spot_instance_remedyboolean

是否开启补齐抢占式实例。开启后,当收到抢占式实例将被回收的系统消息时,伸缩组将尝试创建新的实例,替换掉将被回收的抢占式实例。取值:

  • true:开启补齐抢占式实例。
  • false:不开启补齐抢占式实例。
false
compensate_with_on_demandboolean

multi_az_policy取值为COST_OPTIMIZED时,如果因价格、库存等原因无法创建足够的抢占式实例,是否允许自动尝试创建按量实例满足 ECS 实例数量要求。取值:

  • true:允许自动尝试创建按量实例满足 ECS 实例数量要求。
  • false:不允许自动尝试创建按量实例满足 ECS 实例数量要求。
true
internet_charge_typestring

公网 IP 收费类型。取值:

  • PayByBandwidth:按固定带宽计费。
  • PayByTraffic:按使用流量计费。
PayByBandwidth
internet_max_bandwidth_outlong

节点公网 IP 出带宽最大值,单位为 Mbps(Mega bit per second),取值范围:[1,100]

10
image_typestring

操作系统镜像类型,和 platform 参数二选一,取值范围:

  • AliyunLinux:Alinux2 镜像。
  • AliyunLinux3:Alinux3 镜像。
  • AliyunLinux3Arm64:Alinux3 镜像 ARM 版。
  • AliyunLinuxUEFI:Alinux2 镜像 UEFI 版。
  • CentOS:CentOS 镜像。
  • Windows:Windows 镜像。
  • WindowsCore:WindowsCore 镜像。
  • ContainerOS:容器优化镜像。
AliyunLinux
deploymentset_idstring

部署集 ID。

ds-bp1d19mmbsv3jf6xxxxx
desired_sizelong

节点池期望节点数量。

2
private_pool_optionsobject

私有节点池配置。

idstring

私有节点池 ID。

eap-bp67acfmxazb4****
match_criteriastring

私有节点池类型,实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量,供实例启动时选择。取值:

  • Open:开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量,则使用公共池资源启动。

  • Target:指定模式。使用指定的私有池容量启动实例,如果该私有池容量不可用,则实例会启动失败。

  • None:不使用模式。实例启动将不使用私有池容量。

Open
tee_configobject

加密计算节点池配置。

tee_enableboolean

是否为加密计算节点池。

false
managementobject

托管节点池配置。

enableboolean

是否开启托管版节点池,取值:

  • true:开启托管节点池。
  • false:不开启托管节点池,只有当enable=true时,其他相关配置才生效。
false
auto_repairboolean

自动修复,仅当enable=true时生效。

  • true:自动修复。
  • false:不自动修复。
false
upgrade_configobject

自动升级配置,仅当enable=true时生效。

auto_upgradeboolean

是否启用自动升级,取值:

  • true:启用自动升级。
  • false:不启用自动升级。
false
surgelong

额外节点数量。

0
surge_percentagelong

额外节点比例,和surge二选一。

0
max_unavailablelong

最大不可用节点数量,取值范围:[1,1000]。

默认值:1。

0
auto_repair_policyobject

自动修复节点策略。

restart_nodeboolean

是否允许重启节点。

true
auto_vul_fixboolean

是否自动修复 CVE。

true
auto_vul_fix_policyobject

自动修复 CVE 策略。

restart_nodeboolean

是否允许重启节点。

true
vul_levelstring

允许自动修复的漏洞级别,以逗号分隔。

asap,nntf
auto_upgradeboolean

是否自动升级。

true
auto_upgrade_policyobject

自动升级策略。

auto_upgrade_kubeletboolean

是否允许自动升级 kubelet。

true
countlong

【该字段已废弃,请使用 desired_size 代替】

节点池节点数量。

1
interconnect_modestring

边缘节点池的网络类型,该值只对typeedge类型的节点池有意义,取值范围:

  • basic:基础型。
  • private: 专用型。1.22 及以上版本支持。
basic
interconnect_configobject

【该字段已废弃】

边缘节点池配置。

cen_idstring

【该字段已废弃】

边缘增强型节点池绑定的云企业网实例 ID(CENID)。

cen-ey9k9nfhz0f*******
ccn_idstring

【该字段已废弃】

边缘增强型节点池绑定的云连接网实例 ID(CCNID)。

ccn-qm5i0i0q9yi*******
ccn_region_idstring

【该字段已废弃】

边缘增强型节点池绑定的云连接网实例所属的地域。

cn-shanghai
bandwidthlong

【该字段已废弃】

边缘增强型节点池的网络带宽,单位:Mbps。

10
improved_periodstring

【该字段已废弃】

边缘增强型节点池的购买时长,单位:月。

1
max_nodeslong

边缘节点池允许容纳的最大节点数量,该参数大于等于 0。0 表示无额外限制(仅受限于集群整体可以容纳的节点数,节点池本身无额外限制)。边缘节点池该参数值往往大于 0;ess 类型节点池和默认的 edge 类型节点池该参数值为 0。

10
node_configobject

节点配置。

kubelet_configurationkubelet_config

Kubelet 参数配置。

  • 本页导读 (1)