您可以根据节点池ID,调用ModifyClusterNodePool接口更新目标节点池的配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用全部资源表示。
 
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| cs:ModifyClusterNodePool | update | *Cluster acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId} | 
 | 无 | 
请求语法
PUT /clusters/{ClusterId}/nodepools/{NodepoolId} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| ClusterId | string | 是 | 集群 ID。 | c23421cfa74454bc8b37163fd19af**** | 
| NodepoolId | string | 是 | 节点池 ID。 | p31da1b38983f4511b490fc62108a**** | 
| body | object | 否 | 请求体参数。 | |
| nodepool_info | object | 否 | 节点池配置。 | |
| name | string | 否 | 节点池名称。 命名规则:由数字、汉字、英文字符或短划线(-)组成,长度范围 1~63 个字符,且不能以短划线(-)开头。 | default-nodepool | 
| resource_group_id | string | 否 | 节点池的资源组 ID,节点池弹出的实例将属于该资源组内。 一个资源只能归属于一个资源组。根据不同的业务场景,您可以将资源组映射为项目、应用或组织等概念。 | rg-acfmyvw3wjm**** | 
| auto_scaling | object | 否 | 自动伸缩配置。 | |
| enable | boolean | 否 | 是否启用自动伸缩,取值: 
 当取值为 false 时, 默认值: | true | 
| type deprecated | string | 否 | 自动伸缩类型,按照自动伸缩实例类型划分。取值: 
 默认值: | cpu | 
| max_instances | long | 否 | 节点池中可伸缩的最大实例数,不包含您已有的实例。仅当 取值范围[min_instances, 2000],默认值为 0。 | 10 | 
| min_instances | long | 否 | 节点池中可伸缩的最小实例数,不包含您已有的实例。仅当 取值范围[0, max_instances],默认值为 0。 说明 
 | 2 | 
| is_bond_eip deprecated | boolean | 否 | 【该字段已废弃】该字段已废弃,请使用 internet_charge_type 和 internet_max_bandwidth_out 替代。 
 默认值: | null | 
| eip_internet_charge_type deprecated | string | 否 | 【该字段已废弃】请使用 internet_charge_type 和 internet_max_bandwidth_out 替代。 EIP 计费类型,取值: 
 默认值: | null | 
| eip_bandwidth deprecated | long | 否 | 【该字段已废弃】请使用 internet_charge_type 和 internet_max_bandwidth_out 替代。 EIP 带宽峰值。 取值范围:[1,100],单位:Mbps。 | null | 
| management | object | 否 | 托管节点池配置。 | |
| enable | boolean | 否 | 是否开启托管节点池,取值: 
 默认值: | true | 
| auto_repair | boolean | 否 | 是否自动修复节点,仅当 
 默认值: | true | 
| auto_repair_policy | object | 否 | 自动修复节点策略。 | |
| restart_node | boolean | 否 | 是否允许重启节点,取值: 
 | true | 
| auto_vul_fix | boolean | 否 | 是否自动修复 CVE,取值: 
 | true | 
| auto_vul_fix_policy | object | 否 | 自动修复 CVE 策略。 | |
| restart_node | boolean | 否 | 是否允许重启节点,取值: 
 | true | 
| vul_level | string | 否 | 允许自动修复的漏洞级别,以英文逗号分隔,例如: 
 当 | asap,nntf | 
| auto_upgrade | boolean | 否 | 是否启用自动升级,取值: 
 | true | 
| auto_upgrade_policy | object | 否 | 自动升级策略。 | |
| auto_upgrade_kubelet | boolean | 否 | 是否允许自动升级 kubelet,取值: 
 | true | 
| auto_upgrade_runtime | boolean | 否 | 是否允许自动升级运行时,仅当 
 默认值为 | false | 
| auto_upgrade_os | boolean | 否 | 是否允许自动升级操作系统,仅当 
 默认值为 | false | 
| upgrade_config deprecated | object | 否 | 【该字段已废弃】请使用上层的 自动升级配置,仅当 | |
| auto_upgrade deprecated | boolean | 否 | 【该字段已废弃】请使用上层的 是否启用自动升级: 
 默认值: | true | 
| surge | long | 否 | 额外节点数量。和 升级的时候节点会不可用,您可以创建额外节点补偿集群的负载。 说明 
建议创建的额外节点不超过当前的节点数。
 | 5 | 
| surge_percentage | long | 否 | 额外节点数的百分比,和 额外节点数=额外节点数比例×节点数,例如,设置额外节点数比例为 50%,存在的节点数为 6,那么将产生的额外节点数=50%×6,也就是将产生 3 个额外节点数。 | 0 | 
| max_unavailable | long | 否 | 最大不可用节点数量。 取值范围:[1,1000] 默认值:1。 | |
| scaling_group | object | 否 | 节点池伸缩组配置。 | |
| vswitch_ids | array | 否 | 虚拟交换机 ID 列表,取值范围[1,8]。 说明 
为保证高可用性,建议选择不同可用区的虚拟交换机。
 | |
| string | 否 | 虚拟交换机 ID。 | vsw-wz9uwxhawmtzg7u9h**** | |
| instance_types | array | 否 | 节点实例规格列表,您可以选择多个实例规格作为备选,每个节点创建时,将从第一个规格开始尝试购买,直到创建成功。最终购买的实例规格可能随库存变化而不同。 支持的实例规格数量范围:[1,10] | |
| string | 否 | 实例规格。请参见实例规格族。 | ecs.c6.large | |
| instance_charge_type | string | 否 | 节点池节点付费类型,取值: 
 默认值: | PostPaid | 
| period | long | 否 | 节点池节点包年包月时长,仅当 
 | 1 | 
| period_unit | string | 否 | 节点池节点付费周期,仅当 
 默认值: | Month | 
| auto_renew | boolean | 否 | 节点是否开启自动续费,当 
 默认值: | true | 
| auto_renew_period | long | 否 | 单次自动续费的续费时长。取值范围: 
 默认值:1。 | 1 | 
| spot_strategy | string | 否 | 抢占式实例类型,取值: 
 更多信息,请参见抢占式实例。 | SpotWithPriceLimit | 
| spot_price_limit | array<object> | 否 | 抢占实例市场价格区间配置。 | |
| object | 否 | 抢占实例市场价格区间配置。 | ||
| instance_type | string | 否 | 抢占式实例规格。 | ecs.c6.large | 
| price_limit | string | 否 | 单台实例上限价格。 单位:元/小时。 | 0.39 | 
| image_type | string | 否 | 操作系统发行版类型,推荐使用该字段指定节点操作系统。取值: 
 | AliyunLinux3 | 
| image_id | string | 否 | 自定义镜像 ID。可通过 | aliyun_3_x64_20G_alibase_20241218.vhd | 
| system_disk_category | string | 否 | 节点系统盘类型,取值: 
 默认值: | cloud_efficiency | 
| system_disk_categories | array | 否 | 系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时,自动尝试下一优先级的磁盘类型创建系统盘。 | |
| string | 否 | 节点的多系统盘类型。 取值范围: 
 | cloud_essd | |
| system_disk_size | long | 否 | 节点系统盘大小,单位为 GiB。 取值范围:[20,2048]。 该参数的取值必须大于或者等于 max{20, ImageSize}。 默认值:max{40, 参数 ImageId 对应的镜像大小}。 | 120 | 
| system_disk_performance_level | string | 否 | 节点系统盘磁盘性能,只对 ESSD 磁盘生效。磁盘性能等级和磁盘大小有关。更多信息,请参见 ESSD 云盘。 
 | PL1 | 
| system_disk_encrypted | boolean | 否 | 是否加密系统盘。取值范围: 
 | false | 
| system_disk_kms_key_id | string | 否 | 系统盘使用的 KMS 密钥 ID。 | 0e478b7a-4262-4802-b8cb-00d3fb40**** | 
| system_disk_encrypt_algorithm | string | 否 | 系统盘采用的加密算法。取值范围:aes-256。 | aes-256 | 
| system_disk_provisioned_iops | long | 否 | 节点系统盘预配置的读写 IOPS。 可能值:0~min{50,000, 1000*容量-基准性能}。 基准性能=min{1,800+50*容量, 50000}。 当 | 1000 | 
| system_disk_bursting_enabled | boolean | 否 | 节点系统盘是否开启 Burst(性能突发)。 取值: 
 当 | true | 
| data_disks | array | 否 | 节点数据盘配置,取值范围[0,10]。最多支持添加 10 块数据盘。 | |
| data_disk | 否 | 节点数据盘配置。 | ||
| key_pair | string | 否 | 密钥对名称,和 | pro-nodepool | 
| login_password | string | 否 | SSH 登录密码,和 | Hello1234 | 
| internet_charge_type | string | 否 | 公网 IP 收费类型。取值: 
 | PayByBandwidth | 
| internet_max_bandwidth_out | long | 否 | 节点公网 IP 出带宽最大值,单位为 Mbps(Mega bit per second),取值范围:[1,100]。 | 5 | 
| tags | array | 否 | 仅为 ECS 实例添加标签。 标签键不可以重复,最大长度为 128 个字符;标签键和标签值都不能以“aliyun”、“acs:”开头,或包含“https://”、“http://”。 | |
| tag | 否 | ECS 实例标签。 | ||
| desired_size | long | 否 | 节点池期望节点数量。 节点池应该维持的总节点数量,建议至少配置 2 个节点,以确保集群组件正常运行。您可以通过调整期望节点数,达到扩容或缩容节点池的目的。 如无需创建节点,可填写为 0,后续再手动调整,增加节点数。 | 2 | 
| multi_az_policy | string | 否 | 多可用区伸缩组 ECS 实例扩缩容策略。取值: 
 默认值: | BALANCE | 
| scaling_policy | string | 否 | 伸缩组模式,取值: 
 | release | 
| on_demand_base_capacity | long | 否 | 伸缩组所需要按量实例个数的最小值,取值范围:[0,1000]。当按量实例个数少于该值时,将优先创建按量实例。 | 0 | 
| on_demand_percentage_above_base_capacity | long | 否 | 伸缩组满足最小按量实例数( | 20 | 
| spot_instance_pools | long | 否 | 指定可用实例规格的个数,伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围:[1,10]。 | 5 | 
| spot_instance_remedy | boolean | 否 | 是否开启补齐抢占式实例。开启后,当收到抢占式实例将被回收的系统消息时,伸缩组将尝试创建新的实例,替换掉将被回收的抢占式实例。取值: 
 | false | 
| compensate_with_on_demand | boolean | 否 | 当 
 | true | 
| rds_instances | array | 否 | RDS 实例列表。 | |
| string | 否 | RDS 实例 ID。如果指定了 RDS 实例列表,集群节点 ECS 会自动加入 RDS 访问白名单。 | rds-xxx | |
| private_pool_options | object | 否 | 私有节点池配置。 | |
| id | string | 否 | 私有节点池 ID。当 | eap-bp67acfmxazb4**** | 
| match_criteria | string | 否 | 私有节点池类型,实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量,供实例启动时选择。取值: 
 | Open | 
| platform deprecated | string | 否 | 【该字段已废弃】请使用 操作系统平台。取值: 
 | AliyunLinux | 
| instance_patterns | array | 否 | 实例属性配置。 | |
| instance_patterns | 否 | 实例属性。 | ||
| deploymentset_id | string | 否 | 节点池弹出 ECS 所属的部署集,仅对增量节点生效,存量节点的部署集不会变更。 | ds-bp1d19mmbsv3jf6xxxxx | 
| security_group_ids | array | 否 | 安全组 ID 列表。 | |
| string | 否 | 安全组 ID。 | sg-wz9a8g2mt6x5ll****** | |
| kubernetes_config | object | 否 | 集群相关配置。 | |
| labels | array | 否 | 节点标签,为 Kubernetes 集群节点添加标签。标签定义规则: 
 | |
| tag | 否 | 节点标签。 | ||
| taints | array | 否 | 节点污点配置。 | |
| taint | 否 | 节点污点配置。 | ||
| runtime | string | 否 | 容器运行时名称,ACK 支持以下三种容器运行时。 
 默认值:containerd。 | containerd | 
| runtime_version | string | 否 | 容器运行时版本。 | 1.6.38 | 
| cpu_policy | string | 否 | 节点 CPU 管理策略。当集群版本在 1.12.6 及以上时支持以下两种策略: 
 默认值: | none | 
| unschedulable | boolean | 否 | 扩容后的节点是否不可调度。 
 | false | 
| user_data | string | 否 | 实例自定义数据。节点加入集群后,将运行您指定的实例自定义数据脚本。请参见User-Data 脚本。 | IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi | 
| cms_enabled | boolean | 否 | 是否在 ECS 节点上安装云监控,安装后可以在云监控控制台查看所创建 ECS 实例的监控信息,推荐开启。取值: 
 默认值: | true | 
| pre_user_data | string | 否 | 实例预自定义数据。节点加入集群前,将运行您指定的实例预自定义数据脚本。请参见User-Data 脚本。 | IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi | 
| tee_config | object | 否 | 加密计算集群配置。 | |
| tee_enable | boolean | 否 | 是否开启加密计算集群,取值: 
 默认值: | false | 
| update_nodes | boolean | 否 | 同步更新节点标签及污点。 | true | 
| concurrency | boolean | 否 | 是否并发。 | true | 
返回参数
示例
正常返回示例
JSON格式
{
  "task_id": "T-5fd211e924e1d00787000293",
  "nodepool_id": "np737c3ac1ac684703b9e10673aa2c****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|---|---|
| 2024-09-27 | API 内部配置变更,不影响调用 | 查看变更详情 | 
| 2024-06-13 | API 内部配置变更,不影响调用 | 查看变更详情 | 
| 2024-06-13 | API 内部配置变更,不影响调用 | 查看变更详情 | 
| 2024-04-19 | API 内部配置变更,不影响调用 | 查看变更详情 | 
| 2024-01-19 | OpenAPI 返回结构发生变更 | 查看变更详情 | 
| 2023-12-15 | API 内部配置变更,不影响调用 | 查看变更详情 | 
| 2023-12-13 | API 内部配置变更,不影响调用 | 查看变更详情 | 
| 2023-10-17 | API 内部配置变更,不影响调用 | 查看变更详情 | 
| 2022-08-30 | API 内部配置变更,不影响调用 | 查看变更详情 | 
| 2022-08-10 | API 内部配置变更,不影响调用 | 查看变更详情 | 
| 2020-09-23 | API 内部配置变更,不影响调用 | 查看变更详情 | 
