| object | | |
nodepool_info | object | | |
nodepool_id | string | | np615c0e0966124216a0412e10afe0**** |
name | string | 节点池名称。
命名规则:由数字、汉字、英文字符或短划线(-)组成,长度范围 1~63 个字符,且不能以短划线(-)开头。 | default-nodepool |
type | string | | ess |
is_default | boolean | 是否为默认节点池,通常一个集群仅有一个默认节点池。取值:
true :设置为默认节点池。
false :不设置为默认节点池。 | true |
resource_group_id | string | | rg-acfmyvw3wjmb**** |
region_id | string | | cn-beijing |
created | string | | 2020-09-27T19:14:09.156823496+08:00 |
updated | string | | 2020-09-27T20:37:46+08:00 |
status | object | | |
state | string | 节点池状态,取值:
active :已激活。
scaling :伸缩中。
removing :节点移除中。
deleting :删除中。
updating :更新中。
| active |
healthy_nodes | long | | 3 |
initial_nodes | long | | 0 |
failed_nodes | long | | 0 |
offline_nodes | long | | 0 |
removing_nodes | long | | 0 |
serving_nodes | long | | 3 |
total_nodes | long | | 3 |
auto_scaling | object | | |
enable | boolean | 是否启用自动伸缩。取值:
true :开启节点池自动伸缩功能。
false :不开启自动伸缩,当取值为 false 时,auto_scaling 内的其他配置参数将不生效。
| true |
type | string | 自动伸缩类型,按照自动伸缩实例类型划分。取值:
cpu :普通实例型。
gpu :GPU 实例型。
gpushare :GPU 共享型。
spot :抢占式实例型。
| cpu |
max_instances | long | | 10 |
min_instances | long | | 1 |
eip_internet_charge_type | string | EIP 计费类型,取值:
PayByBandwidth :按固定带宽计费。
PayByTraffic :按使用流量计费。
| PayByBandwidth |
is_bond_eip | boolean | 是否绑定 EIP,取值:
true :绑定 EIP。
false :不绑定 EIP。
| true |
eip_bandwidth | long | | 5 |
management | object | | |
enable | boolean | 是否开启托管版节点池,取值:
true :开启托管节点池。
false :不开启托管节点池,只有当enable=true 时,其他相关配置才生效。
| true |
auto_repair | boolean | | true |
auto_repair_policy | object | | |
restart_node | boolean | | true |
auto_vul_fix | boolean | | true |
auto_vul_fix_policy | object | | |
restart_node | boolean | | true |
vul_level | string | | asap,nntf |
auto_upgrade | boolean | | true |
auto_upgrade_policy | object | | |
auto_upgrade_kubelet | boolean | | true |
upgrade_config | object | | |
auto_upgrade | boolean | 是否启用自动升级,取值:
true :启用自动升级。
false :不启用自动升级。
| true |
surge | long | | 5 |
surge_percentage | long | | 50 |
max_unavailable | long | 最大不可用节点数量,取值范围:[1,1000]。
默认值:1。 | 1 |
scaling_group | object | | |
scaling_group_id | string | | asg-2zeieod8giqmov7z**** |
vswitch_ids | array | 虚拟交换机 ID,取值范围:[1,20]。
说明
为保证高可用性,建议选择不同可用区的虚拟交换机。
| |
| string | | vsw-2ze3ds0mdip0hdz8i**** |
instance_types | array | 节点实例规格列表,您可以选择多个实例规格作为备选,每个节点创建时,将从第一个规格开始尝试购买,直到创建成功。最终购买的实例规格可能随库存变化而不同。 | |
| string | | ecs.n4.large |
instance_charge_type | string | 节点池节点付费类型,取值:
PrePaid :预付费。
PostPaid :按量付费。
| PostPaid |
period | long | 节点包年包月时长,当instance_charge_type 取值为PrePaid 时才生效且为必选值。
当PeriodUnit=Month 时,取值范围:{1, 2 , 3, 6, 12, 24, 36, 48, 60}。 | 0 |
period_unit | string | 节点付费周期,当instance_charge_type 取值为PrePaid 时时候需要指定周期。
Month :目前只支持以月为单位。
| Month |
auto_renew | boolean | 节点是否开启自动续费,当instance_charge_type 取值为PrePaid 时才生效,取值:
| false |
auto_renew_period | long | 节点自动续费周期。当instance_charge_type 取值为PrePaid 时才生效,且为必选值。
当PeriodUnit=Month 时,取值范围:{1, 2, 3, 6, 12}。 | 1 |
spot_strategy | string | 抢占式实例类型,取值:
- NoSpot:非抢占式实例。
- SpotWithPriceLimit:设置抢占实例价格上限。
- SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。
更多信息,请参见抢占式实例。 | NoSpot |
spot_price_limit | object [] | | |
instance_type | string | | ecs.c6.large |
price_limit | string | | 0.39 |
image_type | string | | AliyunLinux |
image_id | string | 自定义镜像 ID,可通过DescribeKubernetesVersionMetadata 查询系统支持的镜像。 | aliyun_2_1903_x64_20G_alibase_20200529.vhd |
system_disk_category | string | 节点系统盘类型,取值:
cloud_efficiency :高效云盘。
cloud_ssd :SSD 云盘。
| cloud_efficiency |
system_disk_categories | array | 系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时,自动尝试下一优先级的磁盘类型创建系统盘。取值范围:cloud:普通云盘。cloud_efficiency:高效云盘。cloud_ssd:SSD 云盘。cloud_essd:ESSD 云盘。 | |
| string | | cloud_essd |
system_disk_size | long | 节点系统盘大小,单位为 GiB。
取值范围:[20,500]。 | 120 |
system_disk_performance_level | string | | PL1 |
system_disk_encrypted | boolean | 是否加密系统盘。取值范围:true:加密。false:不加密。 | false |
system_disk_kms_key_id | string | | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
system_disk_encrypt_algorithm | string | | aes-256 |
system_disk_bursting_enabled | boolean | 节点系统盘是否开启 Burst(性能突发),磁盘类型为 cloud_auto 时配置。 | true |
system_disk_provisioned_iops | long | 节点系统盘预配置的读写 IOPS,磁盘类型为 cloud_auto 时配置。 | 1000 |
data_disks | array | | |
| data_disk | | |
security_group_ids | array | | |
| string | | sg-2ze60ockeekspl3d**** |
key_pair | string | 密钥对名称,和login_password 二选一。当节点池为托管版节点池时,只支持key_pair 。 | pro-nodepool |
login_password | string | SSH 登录密码,和key_pair 二选一。密码规则为 8~30 个字符,且至少同时包含三项(大小写字母、数字和特殊符号)。
出于安全性考虑,密码查询结果经过加密处理。 | ******** |
login_as_non_root | boolean | 弹出的 ECS 实例是否使用以非 root 用户登录。 | true |
cis_enabled | boolean | 【已废弃】请使用参数 security_hardening_os 替代。 | false |
soc_enabled | boolean | 是否开启等保加固,仅当系统镜像选择 Alibaba Cloud Linux 2 或 Alibaba Cloud Linux 3 时,可为节点开启等保加固。阿里云为 Alibaba Cloud Linux 2 和 Alibaba Cloud Linux 3 等保 2.0 三级版镜像提供等保合规的基线检查标准和扫描程序。 | false |
security_hardening_os | boolean | 阿里云 OS 安全加固。取值:
true :开启阿里云 OS 安全加固。
false :不开启阿里云 OS 安全加固。
默认值:false 。 | false |
internet_charge_type | string | | PayByBandwidth |
internet_max_bandwidth_out | long | 节点公网 IP 出带宽最大值,单位为 Mbps(Mega bit per second),取值范围:1~100。 | 10 |
tags | array | 仅为 ECS 实例添加标签。
标签键不可以重复,最大长度为 128 个字符;标签键和标签值都不能以“aliyun”、“acs:”开头,或包含“https://”、“http://”。 | |
| tag | | |
desired_size | long | | 2 |
multi_az_policy | string | 多可用区伸缩组 ECS 实例扩缩容策略。取值:
-
PRIORITY :根据您定义的虚拟交换机(VSwitchIds.N)扩缩容。当优先级较高的虚拟交换机所在可用区无法创建 ECS 实例时,自动使用下一优先级的虚拟交换机创建 ECS 实例。
-
COST_OPTIMIZED :按 vCPU 单价从低到高进行尝试创建。当伸缩配置设置了抢占式计费方式的多实例规格时,优先创建对应抢占式实例。您可以继续通过CompensateWithOnDemand 参数指定当抢占式实例由于库存等原因无法创建时,是否自动尝试以按量付费的方式创建。
说明
COST_OPTIMIZED 仅在伸缩配置设置了多实例规格或者选用了抢占式实例的情况下生效。
-
BALANCE :在伸缩组指定的多可用区之间均匀分配 ECS 实例。如果由于库存不足等原因可用区之间变得不平衡,您可以通过 API RebalanceInstances 平衡资源。更多信息,请参见 RebalanceInstances 。
默认值:PRIORITY 。 | BALANCE |
scaling_policy | string | 伸缩组模式,取值:
release :标准模式,根据申请资源值的使用量,通过创建、释放 ECS 的方式进行伸缩。
recycle :极速模式,通过创建、停机、启动的方式进行伸缩,提高再次伸缩的速度(停机时计算资源不收费,只收取存储费用,本地盘机型除外)。
| release |
on_demand_base_capacity | long | 伸缩组所需要按量实例个数的最小值,取值范围:[0,1000]。当按量实例个数少于该值时,将优先创建按量实例。 | 0 |
on_demand_percentage_above_base_capacity | long | 伸缩组满足最小按量实例数(on_demand_base_capacity )要求后,超出的实例中按量实例应占的比例。取值范围:[0,100]。 | 20 |
spot_instance_pools | long | 指定可用实例规格的个数,伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围:[1,10]。 | 5 |
spot_instance_remedy | boolean | 是否开启补齐抢占式实例。开启后,当收到抢占式实例将被回收的系统消息时,伸缩组将尝试创建新的实例,替换掉将被回收的抢占式实例。取值:
true :开启补齐抢占式实例。
false :不开启补齐抢占式实例。
| false |
compensate_with_on_demand | boolean | 当multi_az_policy 取值为COST_OPTIMIZED 时,如果因价格、库存等原因无法创建足够的抢占式实例,是否允许自动尝试创建按量实例满足 ECS 实例数量要求。取值:
true :允许自动尝试创建按量实例满足 ECS 实例数量要求。
false :不允许自动尝试创建按量实例满足 ECS 实例数量要求。
| true |
deploymentset_id | string | | ds-bp1d19mmbsv3jf6xxxxx |
rds_instances | array | 如果指定了 RDS 实例列表,集群节点 ECS 会自动加入 RDS 访问白名单。 | |
| string | | rm-xxx |
private_pool_options | object | | |
id | string | | eap-bp67acfmxazb4**** |
match_criteria | string | 私有节点池类型,实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量,供实例启动时选择。取值:
-
Open :开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量,则使用公共池资源启动。
-
Target :指定模式。使用指定的私有池容量启动实例,如果该私有池容量不可用,则实例会启动失败。
-
None :不使用模式。实例启动将不使用私有池容量。
| Open |
security_group_id | string | 节点池安全组 ID,当节点池绑定了多个安全组时,为security_group_ids 中的第一个值。 | sg-2ze60ockeekspl3d**** |
platform | string | 操作系统发行版。取值:
CentOS
AliyunLinux
Windows
WindowsCore
| AliyunLinux |
ram_policy | string | Worker RAM 角色名称,授权 ECS 实例为集群 Woker 节点。 | KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e**** |
node_config | object | | |
kubelet_configuration | kubelet_config | | |
kubernetes_config | object | | |
labels | array | 节点标签,为 Kubernetes 集群节点添加标签。标签定义规则:
- 标签由区分大小写的键值对组成,您最多可以设置 20 个标签。
- 标签键不可以重复,最长为 64 个字符;标签值可以为空,最长为 128 个字符。标签键和标签值都不能以
aliyun 、acs: 、https:// 或http:// 开头。更多信息,请参见Labels and Selectors。
| |
| tag | | |
taints | array | | |
| taint | | |
runtime | string | | docker |
runtime_version | string | | 19.03.5 |
cpu_policy | string | 节点 CPU 管理策略。当集群版本在 1.12.6 及以上时支持以下两种策略:
static :允许为节点上具有某些资源特征 Pod 增强其 CPU 亲和性和独占性。
none :表示启用现有的默认 CPU 亲和性方案。
| none |
user_data | string | | IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi |
unschedulable | boolean | | true |
cms_enabled | boolean | 是否在 ECS 节点上安装云监控,安装后可以在云监控控制台查看所创建 ECS 实例的监控信息,推荐开启。取值:
true :在 ECS 节点上安装云监控。
false :不在 ECS 节点上安装云监控。
| true |
node_name_mode | string | 节点名称由三部分组成:前缀 + 节点 IP 地址子串 + 后缀:
- 前缀和后缀均可由“.”分隔的一个或多个部分构成,每个部分可以使用小写字母、数字和“-”,节点名称首尾必须为小写字母和数字。
- IP 地址段长度指截取节点 IP 地址末尾的位数,取值范围 5-12。
例如,节点 IP 地址为:192.168.0.55,指定前缀为 aliyun.com,IP 地址段长度为 5,后缀为 test,则节点名称为 aliyun.com00055test。 | customized,test.,5,.com |
tee_config | object | | |
tee_enable | boolean | | false |
interconnect_config | object | 【该字段已废弃】
边缘节点池网络相关的配置。该值只对 edge 类型的节点池有意义。 | |
cen_id | string | 【该字段已废弃】
边缘增强型节点池绑定的云企业网实例 ID (CENID)。 | cen-ey9k9nfhz0f******* |
ccn_id | string | 【该字段已废弃】
边缘增强型节点池绑定的云连接网实例 ID (CCNID)。 | ccn-qm5i0i0q9yi******* |
ccn_region_id | string | 【该字段已废弃】
边缘增强型节点池绑定的云连接网实例所属的区域。 | cn-shanghai |
bandwidth | long | 【该字段已废弃】
边缘增强型节点池的网络带宽,单位为 Mbps。 | 10 |
improved_period | string | 【该字段已废弃】
边缘增强型节点池的购买时长,单位为月。 | 1 |
max_nodes | long | 边缘节点池允许容纳的最大节点数量. 节点池内可以容纳的最大节点数量,该参数大于等于 0。0 表示无额外限制(仅受限于集群整体可以容纳的节点数,节点池本身无额外限制)。边缘节点池该参数值往往大于 0;ess 类型节点池和默认的 edge 类型节点池该参数值为 0。 | 10 |
interconnect_mode | string | 边缘节点池的网络类型。该值只对 edge 类型的节点池有意义。
- basic:基础型;
- dedicated:专用型。
| basic |