文档

ModifyClusterNodePool - 修改节点池配置

更新时间:

您可以根据节点池ID,调用ModifyClusterNodePool接口更新目标节点池的配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:ModifyClusterNodePoolWrite
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

PUT /clusters/{ClusterId}/nodepools/{NodepoolId}

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

c23421cfa74454bc8b37163fd19af****
NodepoolIdstring

节点池 ID。

p31da1b38983f4511b490fc62108a****
bodyobject

请求体参数。

nodepool_infoobject

节点池配置。

namestring

节点池名称。

命名规则:由数字、汉字、英文字符或短划线(-)组成,长度范围 1~63 个字符,且不能以短划线(-)开头。

default-nodepool
resource_group_idstring

资源组 ID。

rg-acfmyvw3wjm****
auto_scalingobject

自动伸缩配置。

enableboolean

是否启用自动伸缩,取值:

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

默认值:false

true
typestring

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

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

默认值:cpu

cpu
max_instanceslong

最大实例数。

10
min_instanceslong

最小实例数。

2
is_bond_eipboolean

是否绑定 EIP,取值:

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

默认值:false

true
eip_internet_charge_typestring

EIP 计费类型,取值:

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

默认值:PayByBandwidth

PayByBandwidth
eip_bandwidthlong

EIP 带宽峰值。

5
managementobject

托管节点池配置。

enableboolean

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

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

默认值:false

true
auto_repairboolean

是否自动修复,仅当enable=true时生效。取值:

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

默认值:true

true
auto_repair_policyobject

自动修复节点策略。

restart_nodeboolean

是否允许重启节点,取值:

  • true:允许重启节点。
  • false:不允许重启节点。
true
auto_vul_fixboolean

是否自动修复 CVE,取值:

  • true:允许自动修复 CVE。
  • false:不允许自动修复 CVE。
true
auto_vul_fix_policyobject

自动修复 CVE 策略。

restart_nodeboolean

是否允许重启节点,取值:

  • true:允许重启节点。
  • false:不允许重启节点。
true
vul_levelstring

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

asap,nntf
auto_upgradeboolean

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

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

自动升级策略。

auto_upgrade_kubeletboolean

是否允许自动升级 kubelet,取值:

  • true:允许自动升级 kubelet。
  • false:不允许自动升级 kubelet。
true
auto_upgrade_runtimeboolean

是否允许自动升级运行时,仅当auto_upgrade=true时生效。取值:

  • true:允许自动升级运行时。
  • false:不允许自动升级运行时。

默认值为false

auto_upgrade_osboolean

是否允许自动升级操作系统,仅当auto_upgrade=true时生效。取值:

  • true:允许自动升级操作系统。
  • false:不允许自动升级操作系统。

默认值为false

upgrade_configobject

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

auto_upgradeboolean

是否启用自动升级:

  • true:启用。
  • false:不启用。

默认值:true

true
surgelong

额外节点数量。升级的时候节点会不可用,您可以创建额外节点补偿集群的负载。

说明 建议创建的额外节点不超过当前的节点数。
5
surge_percentagelong

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

0
max_unavailablelong

最大不可用节点数量。

取值范围:[1,1000]

默认值:1。

1
scaling_groupobject

扩容组配置。

vswitch_idsarray

虚拟交换机 ID 列表,取值范围[1,20]。

说明 为保证高可用性,建议选择不同可用区的虚拟交换机。
string

虚拟交换机 ID。

vsw-wz9uwxhawmtzg7u9h****
instance_typesarray

节点实例规格列表,您可以选择多个实例规格作为备选,每个节点创建时,将从第一个规格开始尝试购买,直到创建成功。最终购买的实例规格可能随库存变化而不同。

string

实例规格。更多信息,请参见实例规格族

ecs.c6.large
instance_charge_typestring

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

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

默认值:PostPaid

PostPaid
periodlong

节点包年包月时长,当instance_charge_type取值为PrePaid时才生效且为必选值。

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

1
period_unitstring

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

目前只支持以月为计时单位。

默认值:Month

Month
auto_renewboolean

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

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

默认值:true

true
auto_renew_periodlong

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

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

1
spot_strategystring

抢占式实例类型,取值:

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

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

SpotWithPriceLimit
spot_price_limitobject []

抢占实例市场价格区间配置。

instance_typestring

抢占式实例规格。

ecs.c6.large
price_limitstring

单台实例上限价格。

单位:元/小时。

0.39
image_typestring

操作系统发行版类型,推荐使用该字段指定节点操作系统。取值:CentOS、AliyunLinux、AliyunLinux Qboot、AliyunLinuxUEFI、AliyunLinux3、Windows、WindowsCore、AliyunLinux3Arm64、ContainerOS。

AliyunLinux
image_idstring

自定义镜像 ID。可通过DescribeKubernetesVersionMetadata查询系统支持的镜像,默认使用系统最新镜像。

aliyun_2_1903_x64_20G_alibase_20200904.vhd
system_disk_categorystring

节点系统盘类型,取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。

默认值:cloud_ssd

cloud_efficiency
system_disk_categoriesarray

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

string

节点系统盘类型

cloud_essd
system_disk_sizelong

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

取值范围:[20,500]。

该参数的取值必须大于或者等于 max{20, ImageSize}。

默认值:max{40, 参数 ImageId 对应的镜像大小}。

120
system_disk_performance_levelstring

节点系统盘磁盘性能等级, 仅对 ESSD 磁盘生效。磁盘性能等级和磁盘大小有关。更多信息,请参见 ESSD 云盘

PL1
system_disk_encryptedboolean

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

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,磁盘类型为 cloud_auto 时配置。

1000
system_disk_bursting_enabledboolean

节点系统盘是否开启 Burst(性能突发),磁盘类型为 cloud_auto 时配置。

true
data_disksarray

节点数据盘配置,取值范围[0,10]。最多支持添加 10 块数据盘。

data_disk

节点数据盘配置。

key_pairstring

密钥对名称,和login_password二选一。当节点池为托管版节点池时,只支持key_pair

pro-nodepool
login_passwordstring

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

Hello1234
internet_charge_typestring

公网 IP 收费类型。取值:

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

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

5
tagsarray

仅为 ECS 实例添加标签。

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

tag

ECS 实例标签。

desired_sizelong

节点池期望节点数。

2
multi_az_policystring

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

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

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

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

默认值:PRIORITY

BALANCE
scaling_policystring

伸缩组模式,取值:

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

RDS 实例列表。

string

RDS 实例 ID。如果指定了 RDS 实例列表,集群节点 ECS 会自动加入 RDS 访问白名单。

rds-xxx
private_pool_optionsobject

私有节点池配置。

idstring

私有节点池 ID。

eap-bp67acfmxazb4****
match_criteriastring

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

  • Open:开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量,则使用公共池资源启动。
  • Target:指定模式。使用指定的私有池容量启动实例,如果该私有池容量不可用,则实例会启动失败。
  • None:不使用模式。实例启动将不使用私有池容量。
Open
platformstring

操作系统平台。取值:

  • AliyunLinux
  • CentOS
  • Windows
  • WindowsCore
AliyunLinux
kubernetes_configobject

集群相关配置。

labelsarray

节点标签,为 Kubernetes 集群节点添加标签。标签定义规则:

  • 标签由区分大小写的键值对组成,您最多可以设置 20 个标签。
  • 标签键不可以重复,最长为 64 个字符;标签值可以为空,最长为 128 个字符。标签键和标签值都不能以aliyunacs:https://http://开头。更多信息,请参见Labels and Selectors
tag

节点标签。

taintsarray

节点污点配置。

taint

节点污点配置。

runtimestring

容器运行时名称。

docker
runtime_versionstring

容器运行时版本。

19.03.5
cpu_policystring

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

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

默认值:none

none
unschedulableboolean

扩容后的节点是否不可调度。

false
user_datastring

节点池自定义数据。更多信息,请参见生成实例自定义数据

IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi
cms_enabledboolean

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

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

默认值:false

true
tee_configobject

加密计算集群配置。

tee_enableboolean

是否开启加密计算集群,取值:

  • true:开启。
  • false:不开启。

默认值:false

false
update_nodesboolean

同步更新节点标签及污点。

true
concurrencyboolean

是否并发。

true

返回参数

名称类型描述示例值
object

返回体数据。

task_idstring

任务 ID。

T-5fd211e924e1d00787000293
nodepool_idstring

节点池 ID。

np737c3ac1ac684703b9e10673aa2c****
request_idstring

请求 ID。

687C5BAA-D103-4993-884B-C35E4314****

示例

正常返回示例

JSON格式

{
  "task_id": "T-5fd211e924e1d00787000293",
  "nodepool_id": "np737c3ac1ac684703b9e10673aa2c****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-19API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2024-01-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-15API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-13API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-10-17API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-08-30API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-08-10API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2020-09-23API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)