DescribeClusterNodePools - 查询节点池列表

更新时间:
复制为 MD 格式

查询集群内所有节点池列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cs:DescribeClusterNodePools

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

GET /clusters/{ClusterId}/nodepools HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

ClusterId

string

集群 ID。

cc0f87de0b8fb403f86e10e204f83****

请求参数

名称

类型

必填

描述

示例值

NodepoolName

string

节点池名称。

nodepool-test

返回参数

名称

类型

描述

示例值

object

节点池详情。

nodepools

array<object>

节点池实例列表。

array<object>

节点池实例详情。

nodepool_info

object

节点池信息。

nodepool_id

string

节点池 ID。

np615c0e0966124216a0412e10afe0****

name

string

节点池名称。

default-nodepool

type

string

节点池类型。取值:

  • ess:普通节点池(包含托管功能和自动弹性伸缩功能)。

  • edge:边缘节点池。

  • lingjun:灵骏节点池。

ess

is_default

boolean

是否为默认节点池,通常一个集群仅有一个默认节点池。取值:

  • true:默认节点池。

  • false:非默认节点池。

true

resource_group_id

string

资源组 ID。

rg-acfmyvw3wjm****

region_id

string

地域 ID。

cn-beijing

created

string

节点池创建时间。

2025-04-15T16:33:29.362888807+08:00

updated

string

节点池更新时间。

2025-04-15T16:33:32.823+08:00

status

object

节点池状态。

state

string

节点池状态,取值:

  • active:已激活。

  • scaling:伸缩中。

  • removing:节点移除中。

  • deleting:删除中。

  • updating:更新中。

active

healthy_nodes

integer

处于健康状态实例数。

3

initial_nodes

integer

正在创建的节点数。

0

failed_nodes

integer

失败实例数。

0

offline_nodes

integer

离线节点数。

0

removing_nodes

integer

正在被移除的节点数。

0

serving_nodes

integer

处于工作状态的节点数。

3

total_nodes

integer

节点池内节点数量。

3

auto_scaling

object

自动伸缩配置。

enable

boolean

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

  • true:开启节点池自动伸缩功能。当集群的容量规划无法满足应用 Pod 调度时,ACK 会根据配置的最小和最大实例数自动扩缩节点资源。1.24 及以上版本的集群默认启用节点即时弹性; 1.24 以下版本的集群默认启用节点自动伸缩。更多信息,请参见节点伸缩

  • false:不开启自动伸缩,ACK 会根据配置的期望节点数调整节点池中的节点数,将节点数始终维持在期望节点数。

当取值为 false 时,auto_scaling内的其他配置参数将不生效。

true

type

string

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

  • cpu:普通实例型。

  • gpu:GPU 实例型。

  • gpushare:GPU 共享型。

  • spot:抢占式实例型。

cpu

max_instances

integer

节点池中可伸缩的最大实例数,不包含您已有的实例。

10

min_instances

integer

节点池中可伸缩的最小实例数,不包含您已有的实例。

2

eip_internet_charge_type

string

EIP 计费类型,取值:

  • PayByBandwidth:按固定带宽计费。

  • PayByTraffic:按使用流量计费。

PayByBandwidth

is_bond_eip

boolean

是否绑定 EIP,取值:

  • true:绑定 EIP。

  • false:不绑定 EIP。

true

eip_bandwidth

integer

EIP 带宽峰值。

取值范围:[1,100],单位:Mbps。

5

management

object

托管节点池配置,当前只在专业托管集群中生效。

enable

boolean

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

  • true:开启托管节点池。

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

true

auto_repair

boolean

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

  • true:自动修复。

  • false:不自动修复。

true

auto_repair_policy

object

自动修复节点策略。

restart_node

boolean

是否允许重启节点。仅当auto_repair=true时生效。

  • true:允许重启节点。

  • false:不允许重启节点。

true

approval_required

boolean

节点修复是否需要人工审批。

false

auto_repair_policy_id

string

自动修复策略的 ID

r-xxxxxxxxx

auto_vul_fix

boolean

是否自动修复 CVE。仅当enable=true时生效。

  • true:允许自动修复 CVE。

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

true

auto_vul_fix_policy

object

自动修复 CVE 策略。

restart_node

boolean

是否允许重启节点,仅当auto_vul_fix=true时生效。取值:

  • true:允许重启节点。

  • false:不允许重启节点。

true

vul_level

string

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

  • asap:高

  • later:中

  • nntf:低

asap,nntf

exclude_packages

string

指定在漏洞修复过程中应排除的包。

kernel

auto_upgrade

boolean

是否自动升级节点,仅当enable=true时生效。

  • true:启用自动升级。

  • false:不启用自动升级。

true

auto_upgrade_policy

object

自动升级策略。

auto_upgrade_kubelet

boolean

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

  • true:允许自动升级 kubelet。

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

true

upgrade_config

object

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

auto_upgrade

boolean

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

  • true:启用自动升级。

  • false:不启用自动升级。

true

surge

integer

额外节点数量。和surge_percentage二选一。

5

surge_percentage

integer

额外节点数的百分比,和surge二选一。

额外节点数=额外节点数比例×节点数,例如,设置额外节点数比例为 50%,存在的节点数为 6,那么将产生的额外节点数=50%×6,也就是将产生 3 个额外节点数。

50

max_unavailable

integer

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

默认值:1。

1

scaling_group

object

节点池伸缩组配置。

scaling_group_id

string

伸缩组 ID。

asg-2ze8n5qw4atggut8****

vswitch_ids

array

虚拟交换机 ID 列表。

string

虚拟交换机 ID。

vsw-2ze3ds0mdip0hdz8i****

instance_types

array

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

ecs.n4.large

string

节点实例规格。

ecs.n4.large

instance_charge_type

string

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

  • PrePaid:预付费。

  • PostPaid:按量付费。

PostPaid

period

integer

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

  • period_unit=Week时,period取值范围:{ 1、2、3、4}。

  • period_unit=Month时,period 取值范围:{1、2、3、4、5、6、7、8、9、12、24、36、48、60}。

1

period_unit

string

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

  • Month:以月为计时单位。

  • Week:以周为计算单位。

Month

auto_renew

boolean

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

  • true:自动续费。

  • false:不自动续费。

false

auto_renew_period

integer

单次自动续费的续费时长。取值范围:

  • PeriodUnit=Week 时:1、2、3。

  • PeriodUnit=Month 时:1、2、3、6、12、24、36、48、60。

0

spot_strategy

string

抢占式实例类型,取值:

  • NoSpot:非抢占式实例。

  • SpotWithPriceLimit:设置抢占实例价格上限。

  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。

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

NoSpot

spot_price_limit

array<object>

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

object

抢占实例市场价格区间配置,可为不同实例规格设置不同的价格区间。

instance_type

string

抢占式实例规格。

ecs.c6.large

price_limit

string

单台实例市场价格区间。

单位:元/时。

0.39

image_type

string

操作系统镜像类型。

  • AliyunLinux:Alinux2 镜像。

  • AliyunLinuxSecurity:Alinux2 镜像 UEFI 版。

  • AliyunLinux3:Alinux3 镜像。

  • AliyunLinux3Arm64:Alinux3 镜像 ARM 版。

  • AliyunLinux3Security:Alinux3 镜像 UEFI 版。

  • CentOS:CentOS 镜像。

  • Windows:Windows 镜像。

  • WindowsCore:WindowsCore 镜像。

  • ContainerOS:容器优化镜像。

  • AliyunLinux3ContainerOptimized: Alinux3 镜像容器优化版。

AliyunLinux3

image_id

string

自定义镜像 ID,可通过DescribeKubernetesVersionMetadata查询系统支持的镜像。

aliyun_3_x64_20G_alibase_20241218.vhd

system_disk_category

string

节点系统盘类型,取值:

  • cloud_efficiency:高效云盘。

  • cloud_ssd:SSD 云盘。

  • cloud_essd:ESSD 云盘。

  • cloud_auto:ESSD AutoPL 云盘。

  • cloud_essd_entry:ESSD Entry 云盘。

cloud_efficiency

system_disk_categories

array

系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时,自动尝试下一优先级的磁盘类型创建系统盘。

string

节点系统盘类型。

取值:

  • cloud_efficiency:高效云盘。

  • cloud_ssd:SSD 云盘。

  • cloud_essd:ESSD 云盘。

  • cloud_auto:ESSD AutoPL 云盘。

  • cloud_essd_entry:ESSD Entry 云盘。

EESSD云盘

system_disk_size

integer

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

取值范围:[20,2048]。

120

system_disk_performance_level

string

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

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

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

  • PL2:并发极限 I/O 性能较高,读写时延稳定。

  • PL3:并发极限 I/O 性能极高,读写时延极稳定。

PL1

system_disk_encrypted

boolean

是否加密系统盘。取值:

  • true:加密。

  • false:不加密。

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_bursting_enabled

boolean

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

  • true:开启。开启后,波动性业务面临突发的数据读写压力时,云盘会根据业务实际情况临时提升云盘性能,直至业务恢复至平稳状态。

  • false:不开启。

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

true

system_disk_provisioned_iops

integer

节点系统盘预配置的读写 IOPS,磁盘类型为 cloud_auto 时配置。

1000

data_disks

array

节点数据盘类型、大小等配置的组合。

data_disk

节点数据盘配置。

disk_init

array

块设备初始化配置。

DiskInit

DiskInit 配置。

security_group_ids

array

节点池安全组 ID 列表。

string

节点池安全组 ID 列表。

sg-2ze1iuk12m2sb4c4****

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:以非 root 用户(ecs-user)登录。

  • false:以 root 用户登录。

true

cis_enabled deprecated

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

节点公网 IP 网络计费类型。

  • PayByBandwidth:按固定带宽计费。

  • PayByTraffic:按使用流量计费。

PayByBandwidth

internet_max_bandwidth_out

integer

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

10

tags

array

ECS 实例标签。

tag

节点标签。

desired_size

integer

节点池期望节点数。

2

multi_az_policy

string

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

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

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

    说明

    COST_OPTIMIZED仅在伸缩配置设置了多实例规格或者选用了抢占式实例的情况下生效。

  • BALANCE:在伸缩组指定的多可用区之间均匀分配 ECS 实例。如果由于库存不足等原因可用区之间变得不平衡,您可以通过 API RebalanceInstances平衡资源。更多信息,请参见 RebalanceInstances

COST_OPTIMIZED

scaling_policy

string

伸缩组模式,取值:

  • release:标准模式,根据申请资源值的使用量,通过创建、释放 ECS 的方式进行伸缩。

  • recycle:极速模式,通过创建、停机、启动的方式进行伸缩,提高再次伸缩的速度(停机时计算资源不收费,只收取存储费用,本地盘机型除外)。

release

on_demand_base_capacity

integer

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

0

on_demand_percentage_above_base_capacity

integer

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

20

spot_instance_pools

integer

指定可用实例规格的个数,伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围:[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

部署集 ID。

ds-bp1d19mmbsv3jf6xxxxx

rds_instances

array

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

string

RDS 实例。

rm-xxx

private_pool_options

object

私有池选项。

id

string

私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。

eap-bp67acfmxazb4****

match_criteria

string

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

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

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

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

Open

security_group_id

string

【该字段已废弃】

节点池安全组 ID,当节点池绑定多个安全组时,为security_group_ids中的第一个值。

sg-2ze1iuk12m2sb4c4****

platform

string

【该字段已废弃】

操作系统发行版。取值:

  • CentOS

  • AliyunLinux

  • Windows

  • WindowsCore

AliyunLinux

ram_policy

string

该字段已废弃,请使用 ram_role_name 替代。

KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****

instance_patterns

array

实例属性配置。

instance_patterns

实例属性。

ram_role_name

string

Worker RAM 角色名称。

KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****

resource_pool_options

object

创建实例时使用的资源池及资源池策略。

strategy

string

创建实例时使用的资源池策略。取值范围: PrivatePoolFirst:私有池优先。 PrivatePoolOnly:仅限私有池。 None:不使用资源池策略。

PrivatePoolFirst

private_pool_ids

array

私有池 ID 列表。

string

私有池 ID。

eap-bp1c1fohub5jccwi****

system_disk_snapshot_policy_id

string

系统盘快照策略

sp-0jl6xnmme8v7o935****

node_config

object

节点配置。

kubelet_configuration kubelet_config

Kubelet 参数配置。

node_os_config

object

节点操作系统配置。

hugepage

Hugepage

Hugepage 配置。

kubernetes_config

object

集群相关配置。

labels

array

节点标签。

tag

标签配置。

taints

array

节点污点信息。污点和容忍度(Toleration)相互配合,可以用来避免 Pod 被分配到不合适的节点上。更多信息,请参见taint-and-toleration

taint

节点污点信息。

runtime

string

容器运行时名称,ACK 支持以下三种容器运行时。

  • containerd:推荐使用,支持所有集群版本。

  • Sandboxed-Container.runv:安全沙箱容器,提供更高的隔离性,支持 1.31 及以下版本集群。

  • docker:已停止维护,支持 1.22 及以下版本集群。

containerd

runtime_version

string

容器运行时版本。

1.6.38

cpu_policy

string

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

  • static:允许为节点上具有某些资源特征 Pod 增强其 CPU 亲和性和独占性。

  • none:表示启用现有的默认 CPU 亲和性方案。

none

user_data

string

节点池自定义数据,即运行于节点初始化之后的脚本。更多详情,请参见生成实例自定义数据

IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****

unschedulable

boolean

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

  • true:不可调度。

  • false:可调度。

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。

aliyun.com192.XX.YY.55test

pre_user_data

string

节点池预自定义数据,即运行于节点初始化之前的脚本。更多详情,请参见生成实例自定义数据

IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD

tee_config

object

加密计算配置。

tee_enable

boolean

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

  • true:开启。

  • false:不开启。

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

integer

【该字段已废弃】

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

10

improved_period

string

【该字段已废弃】

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

1

max_nodes

integer

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

10

interconnect_mode

string

边缘节点池的网络类型,该参数仅对typeedge类型的节点池生效,取值范围:

  • basic:公网。节点池内的节点通过公网与云端节点进行交互,节点池内应用不能直接访问云端 VPC 内网。

  • private:专用网络。节点池内的节点通过专线、VPN 或 CEN 等方式实现云上与云下网络打通,拥有更高的云边通信质量,提供更有效的安全保障。

basic

auto_mode

object

智能托管配置。

enable

boolean

是否开启智能托管。

node_components

array<object>

节点组件列表。

array<object>

节点组件。

name

string

节点组件名称。

kubelet

version

string

节点组件版本。

1.33.3-aliyun.1

config

object

节点组件配置。

custom_config

object

节点组件自定义配置。

string

节点组件自定义配置字符串。

cpuManagerPolicy

eflo_node_group

object

cluster_id

string

i113790071760688002461

group_id

string

i128147721760688002463

错误码

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

变更历史

更多信息,参考变更详情