获取集群下所有节点池

project_id

是

String

项目ID，获取方式请参见如何获取接口URI中参数。

cluster_id

是

String

集群ID，获取方式请参见如何获取接口URI中参数。

showDefaultNodePool

否

String

是否展示默认节点池。默认不展示，指定为“true”时展示默认节点池。

Content-Type

是

String

消息体的类型（格式）

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。

kind

String

API type. The value is fixed to List.

apiVersion

String

API version. The value is fixed to v3.

items

Array of NodePoolResp objects

/

kind

String

API类型，固定值“NodePool”。

apiVersion

String

API版本，固定值“v3”。

metadata

NodePoolMetadata object

节点池的元数据信息

spec

NodePoolSpec object

节点池的规格描述

status

NodePoolStatus object

节点池状态

name

String

节点名池名称。

uid

String

节点池的uid。创建成功后自动生成，填写无效

annotations

Map<String,String>

节点池的注解，以key value对表示。仅用于查询，不支持请求时传入，填写无效。

updateTimestamp

String

更新时间

creationTimestamp

String

创建时间

type

String

节点池类型。不填写时默认为vm。

• vm：弹性云服务器
• ElasticBMS：C6型弹性裸金属通用计算增强型云服务器，规格示例：c6.22xlarge.2.physical
• pm: 裸金属服务器

nodeTemplate

NodeSpec object

节点池模板详细参数。

initialNodeCount

Integer

节点池初始化节点个数。查询时为节点池目标节点数量。

autoscaling

NodePoolNodeAutoscaling object

弹性伸缩参数。

nodeManagement

NodeManagement object

节点管理相关配置

podSecurityGroups

Array of SecurityID objects

安全组相关配置。

customSecurityGroups

Array of strings

节点池自定义安全组相关配置。支持节点池新扩容节点绑定指定的安全组。

• 未指定安全组ID，新建节点将添加Node节点默认安全组。
• 指定有效安全组ID，新建节点将使用指定安全组。
• 指定安全组，应避免对CCE运行依赖的端口规则进行修改。

flavor

String

节点的规格，CCE支持的节点规格请参考节点规格说明获取。

az

String

待创建节点所在的可用区，需要指定可用区（AZ）的名称，填random选择随机可用区。

os

String

节点的操作系统类型。具体支持的操作系统请参见节点操作系统说明。

login

Login object

节点的登录方式。密钥对和密码登录方式二者必选其一。

rootVolume

Volume object

节点的磁盘信息

dataVolumes

Array of Volume objects

节点的数据盘参数（目前已支持通过控制台为CCE节点添加第二块数据盘）。 如果数据盘正供容器运行时和Kubelet组件使用，则不可被卸载，否则将导致节点不可用。 针对专属云节点，参数解释与rootVolume一致

storage

Storage object

磁盘初始化配置管理参数。

该参数配置逻辑较为复杂，详细说明请参见节点磁盘挂载。

该参数缺省时，按照extendParam中的DockerLVMConfigOverride（已废弃）参数进行磁盘管理。此参数对1.15.11及以上集群版本支持。

publicIP

NodePublicIP object

节点的弹性公网IP

nodeNicSpec

NodeNicSpec object

节点的网卡信息

count

Integer

批量创建时节点的个数，必须为大于等于1，小于等于最大限额的正整数。作用于节点池时该项可以不填写。

billingMode

Integer

节点的计费模式：

• 0: 按需付费

taints

Array of Taint objects

支持给创建出来的节点加Taints来设置反亲和性，taints配置不超过20条。每条Taints包含以下3个参数：

• Key：必须以字母或数字开头，可以包含字母、数字、连字符、下划线和点，最长63个字符；另外可以使用DNS子域作为前缀。
• Value：必须以字符或数字开头，可以包含字母、数字、连字符、下划线和点，最长63个字符。
• Effect：只可选NoSchedule，PreferNoSchedule或NoExecute。 字段使用场景：在节点创建场景下，支持指定初始值，查询时不返回该字段；在节点池场景下，其中节点模板中支持指定初始值，查询时支持返回该字段；在其余场景下，查询时都不会返回该字段。

示例：

"taints": [{
  "key": "status",
  "value": "unavailable",
  "effect": "NoSchedule"
}, {
  "key": "looks",
  "value": "bad",
  "effect": "NoSchedule"
}]

k8sTags

Map<String,String>

格式为key/value键值对。键值对个数不超过20条。

• Key：必须以字母或数字开头，可以包含字母、数字、连字符、下划线和点，最长63个字符；另外可以使用DNS子域作为前缀，例如example.com/my-key，DNS子域最长253个字符。
• Value：可以为空或者非空字符串，非空字符串必须以字符或数字开头，可以包含字母、数字、连字符、下划线和点，最长63个字符。 字段使用场景：在节点创建场景下，支持指定初始值，查询时不返回该字段；在节点池场景下，其中节点模板中支持指定初始值，查询时支持返回该字段；在其余场景下，查询时都不会返回该字段。

示例：

"k8sTags": {
  "key": "value"
}

ecsGroupId

String

云服务器组ID，若指定，将节点创建在该云服务器组下

dedicatedHostId

String

指定DeH主机的ID，将节点调度到自己的DeH上。

userTags

Array of UserTag objects

云服务器标签，键必须唯一，CCE支持的最大用户自定义标签数量依region而定，自定义标签数上限为8个。 字段使用场景：在节点创建场景下，支持指定初始值，查询时不返回该字段；在节点池场景下，其中节点模板中支持指定初始值，查询时支持返回该字段；在其余场景下，查询时都不会返回该字段。

runtime

Runtime object

容器运行时, 默认场景：

• 1.25以下集群：默认为"docker"
• 1.25及以上集群，随操作系统变化，默认的容器运行时不同：操作系统为欧拉2.5、欧拉2.8的节点默认为"docker"，其余操作系统的节点默认为"containerd"

initializedConditions

Array of strings

自定义初始化标记，默认值为空。

CCE节点在初始化完成之前，会打上初始化未完成污点（node.cloudprovider.kubernetes.io/uninitialized）防止pod调度到节点上。用户在创建节点时，可以通过设置initializedConditions参数，控制污点的移除时间（默认不设置超时时间）。

使用示例如下：

1. 创建节点，传入参数 "initializedConditions": ["CCEInitial", "CustomedInitial"]；
2. 用户在执行完自定义初始化操作后，调用k8s接口（例如PATCH /v1/nodes/{node_ip}/status）更新节点的conditions，插入type为CCEInitial、CustomedInitial的两个标记，状态为True，如下所示：

status:
  conditions:
  - type: CCEInitial
    status: 'True'
  - type: CustomedInitial
    status: 'True'

1. CCE组件轮询节点的status.Conditions，查看是否存在type为CCEInitial、CustomedInitial的condition，若存在且status字段值为True，认为节点初始化完成，则移除初始化污点；
2. initializedConditions支持设置超时时间，用户可以在创节点时传入，如："initializedConditions": ["CCEInitial:15m", "CustomedInitial:15m"]，表示超时时间为15分钟，达到超时时间后，当CCE组件轮询到节点时会自动忽略初始化condition，移除初始化污点。

• 必须以字母、数字组成，长度范围1-20位。
• 标记数量不超过2个。
• 超时时间仅支持分钟(m)单位。

extendParam

NodeExtendParam object

创建节点时的扩展参数。

hostnameConfig

HostnameConfig object

K8S节点名称配置参数，支持的集群版本为v1.23.6-r0到v1.25或者v1.25.2-r0及以上。

sshKey

String

选择密钥对方式登录时的密钥对名称。

username

String

登录账号，默认为“root”

password

String

登录密码，若创建节点通过用户名密码方式，即使用该字段，则响应体中该字段作屏蔽展示。 密码复杂度要求：

• 长度为8-26位。
• 密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?~#*）中的三种。
• 密码不能包含用户名或用户名的逆序。 创建节点时password字段需要加盐加密，具体方法请参见创建节点时password字段加盐加密。

size

Integer

磁盘大小，单位为GB

• 系统盘取值范围：40~1024
• 数据盘取值范围：100~32768

volumetype

String

磁盘类型，取值请参见创建云服务器 中“root_volume字段数据结构说明”。

• SAS：高IO，是指由SAS存储提供资源的磁盘类型。
• SSD：超高IO，是指由SSD存储提供资源的磁盘类型。
• SATA：普通IO，是指由SATA存储提供资源的磁盘类型。EVS已下线SATA磁盘，仅存量节点有此类型的磁盘。

extendParam

Map<String,Object>

磁盘扩展参数，取值请参见创建云服务器中“extendparam”参数的描述。

cluster_id

String

云服务器系统盘对应的存储池的ID。仅用作专属云集群，专属分布式存储DSS的存储池ID，即dssPoolID。

cluster_type

String

云服务器系统盘对应的磁盘存储类型。仅用作专属云集群，固定取值为dss。

hw:passthrough

Boolean

• 使用SDI规格创建虚拟机时请关注该参数，如果该参数值为true，说明创建的为SCSI类型的卷
• 节点池类型为ElasticBMS时，此参数必须填写为true
• 如存在节点规格涉及本地盘并同时使用云硬盘场景时，请设置磁盘初始化配置管理参数，参见节点磁盘挂载。

metadata

VolumeMetadata object

云硬盘加密信息，仅在创建节点系统盘或数据盘需加密时须填写。

__system__encrypted

String

表示云硬盘加密功能的字段，'0'代表不加密，'1'代表加密。

该字段不存在时，云硬盘默认为不加密。

__system__cmkid

String

用户主密钥ID，是metadata中的表示加密功能的字段，与__system__encrypted配合使用。

storageSelectors

Array of StorageSelectors objects

磁盘选择，根据matchLabels和storageType对匹配的磁盘进行管理。磁盘匹配存在先后顺序，靠前的匹配规则优先匹配。

storageGroups

Array of StorageGroups objects

由多个存储设备组成的存储组，用于各个存储空间的划分。

name

String

selector的名字，作为storageGroup中selectorNames的索引，因此各个selector间的名字不能重复。

storageType

String

存储类型，当前仅支持evs（云硬盘）或local（本地盘）；local存储类型不支持磁盘选择，所有本地盘将被组成一个VG，因此也仅允许只有一个local类型的storageSelector。

matchLabels

matchLabels object

evs盘的匹配字段，支持DataVolume中的size、volumeType、metadataEncrypted、metadataCmkid、count五个字段。

size

String

匹配的磁盘大小，不填则无磁盘大小限制。例如：100.

volumeType

String

云硬盘类型，目前支持SSD\GPSSD\SAS\ESSD\SATA等。

metadataEncrypted

String

磁盘加密标识符，0代表不加密，1代表加密。

metadataCmkid

String

加密磁盘的用户主密钥ID，长度为36字节的字符串。

count

String

磁盘选择个数，不填则选择所有此类磁盘。

name

String

storageGroups的名字，作为虚拟存储组的名字，因此各个group名字不能重复。

cceManaged

Boolean

k8s及runtime所属存储空间。有且仅有一个group被设置为true，不填默认false。

selectorNames

Array of strings

对应storageSelectors中的name，一个group可选择多个selector；但一个selector只能被一个group选择。

virtualSpaces

Array of VirtualSpace objects

group中空间配置的详细管理。

name

String

virtualSpace的名称，当前仅支持三种类型：kubernetes、runtime、user。

• kubernetes：k8s空间配置，需配置lvmConfig；
• runtime：运行时空间配置，需配置runtimeConfig；
• user：用户空间配置，需配置lvmConfig

size

String

virtualSpace的大小，仅支持整数百分比。例如：90%。

lvmConfig

LVMConfig object

lvm配置管理，适用于kubernetes和user空间配置。 需要注意：一个virtualSpace仅支持一个config配置。

runtimeConfig

RuntimeConfig object

runtime配置管理，适用于运行时空间配置。 需要注意：一个virtualSpace仅支持一个config配置。

lvType

String

LVM写入模式：linear、striped。linear：线性模式；striped：条带模式，使用多块磁盘组成条带模式，能够提升磁盘性能。

path

String

磁盘挂载路径。仅在用户配置中生效。支持包含：数字、大小写字母、点、中划线、下划线的绝对路径。

lvType

String

LVM写入模式：linear、striped。linear：线性模式；striped：条带模式，使用多块磁盘组成条带模式，能够提升磁盘性能。

ids

Array of strings

已有的弹性IP的ID列表。数量不得大于待创建节点数

count

Integer

要动态创建的弹性IP个数。

eip

NodeEIPSpec object

弹性IP参数

iptype

String

弹性IP类型，取值请参见申请EIP接口中publicip.type说明。

bandwidth

NodeBandwidth object

弹性IP的带宽参数

chargemode

String

带宽的计费类型：

• 未传该字段，表示按带宽计费。 - 字段值为空，表示按带宽计费。
• 字段值为“traffic”，表示按流量计费。
• 字段为其它值，会导致创建云服务器失败。

size

Integer

带宽大小，取值请参见取值请参见申请EIP接口中bandwidth.size说明。

sharetype

String

带宽的共享类型，共享类型枚举：PER，表示独享，目前仅支持独享。

primaryNic

NicSpec object

主网卡的描述信息。

extNics

Array of NicSpec objects

扩展网卡

subnetId

String

网卡所在子网的网络ID。主网卡创建时若未指定subnetId,将使用集群子网。扩展网卡创建时必须指定subnetId。

fixedIps

Array of strings

主网卡的IP将通过fixedIps指定，数量不得大于创建的节点数。fixedIps或ipBlock同时只能指定一个。扩展网卡不支持指定fiexdIps。

ipBlock

String

主网卡的IP段的CIDR格式，创建的节点IP将属于该IP段内。fixedIps或ipBlock同时只能指定一个。

key

String

键

value

String

值

effect

String

作用效果

key

String

云服务器标签的键。不得以"CCE-"或"__type_baremetal"开头

value

String

云服务器标签的值

name

String

容器运行时，默认场景：

• v1.25以下集群：默认为"docker"
• v1.25及以上集群，随操作系统变化，默认的容器运行时不同：操作系统为EulerOS 2.5的节点默认为"docker"，其余操作系统的节点默认为"containerd"

ecs:performancetype

String

云服务器规格的分类。响应中会返回此字段。

maxPods

Integer

节点最大允许创建的实例数(Pod)，该数量包含系统默认实例，取值范围为16~256。

该设置的目的为防止节点因管理过多实例而负载过重，请根据您的业务需要进行设置。

节点可以创建多少个Pod，受多个参数影响，具体请参见节点最多可以创建多少Pod。

DockerLVMConfigOverride

String

Docker数据盘配置项（已废弃，请使用storage字段）。默认配置示例如下：

"DockerLVMConfigOverride":"dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear"

默认配置在无VD类型磁盘时，会由于数据盘查找失败而出错，请根据真实盘符类型填写diskType。 包含如下字段：

• userLV（可选）：用户空间的大小，示例格式：vgpaas/20%VG
• userPath（可选）：用户空间挂载路径，示例格式：/home/wqt-test
• diskType：磁盘类型，目前只有evs、hdd和ssd三种格式
• lvType：逻辑卷的类型，目前支持linear和striped两种，示例格式：striped
• dockerThinpool：Docker盘的空间大小，示例格式：vgpaas/60%VG
• kubernetesLV：Kubelet空间大小，示例格式：vgpaas/20%VG

dockerBaseSize

Integer

节点上单容器的可用磁盘空间大小，单位G。

不配置该值或值为0时将使用默认值，Devicemapper模式下默认值为10；OverlayFS模式默认不限制单容器可用空间大小，且dockerBaseSize设置仅在新版本集群的EulerOS节点上生效。

CCE节点容器运行时空间配置请参考数据盘空间分配说明。

Devicemapper模式下建议dockerBaseSize配置不超过80G，设置过大时可能会导致容器运行时初始化时间过长而启动失败，若对容器磁盘大小有特殊要求，可考虑使用挂载外部或本地存储方式代替。

publicKey

String

节点的公钥。

alpha.cce/preInstall

String

安装前执行脚本

alpha.cce/postInstall

String

安装后执行脚本

alpha.cce/NodeImageID

String

如果创建裸金属节点，需要使用自定义镜像时用此参数。

chargingMode

Integer

节点的计费模式。已废弃，请使用NodeSpec中的billingMode字段。

agency_name

String

委托的名称。

委托是由租户管理员在统一身份认证服务（Identity and Access Management，IAM）上创建的，可以为CCE节点提供访问云服务器的临时凭证。 作为响应参数仅在创建节点传入时返回该字段。

kubeReservedMem

Integer

节点内存预留，Kubernetes相关组件预留值。

systemReservedMem

Integer

节点内存预留，系统组件预留值。

init-node-password

String

节点密码，作为响应参数时，固定展示星号。

type

String

K8S节点名称配置类型, 默认为“privateIp”。

• privateIp: 将节点私有IP作为K8S节点名称
• cceNodeName: 将CCE节点名称作为K8S节点名称

enable

Boolean

是否开启自动扩缩容

minNodeCount

Integer

若开启自动扩缩容，最小能缩容的节点个数。不可大于集群规格所允许的节点上限

maxNodeCount

Integer

若开启自动扩缩容，最大能扩容的节点个数，应大于等于 minNodeCount，且不超过集群规格对应的节点数量上限。

scaleDownCooldownTime

Integer

节点保留时间，单位为分钟，扩容出来的节点在这个时间内不会被缩掉

priority

Integer

节点池权重，更高的权重在扩容时拥有更高的优先级

serverGroupReference

String

云服务器组ID，若指定，节点池中所有节点将创建在该云服务器组下，节点池的云服务器组只能在创建时指定，无法修改。指定云服务器组时节点池中的节点数量不允许超出云服务器组的配额限制。

id

String

安全组ID。

currentNode

Integer

当前节点池中所有节点数量（不含删除中的节点）。

creatingNode

Integer

当前节点池中处于创建流程中的节点数量。

deletingNode

Integer

当前节点池中删除中的节点数量。

phase

String

节点池状态。

• 空值：可用（节点池当前节点数已达到预期，且无伸缩中的节点）
• Synchronizing：伸缩中（节点池当前节点数未达到预期，且无伸缩中的节点）
• Synchronized：伸缩等待中（节点池当前节点数未达到预期，或者存在伸缩中的节点）
• SoldOut：节点池当前不可扩容（兼容字段，标记节点池资源配额不足等不可扩容状态）

• Deleting：删除中
• Error：错误

jobId

String

对节点池执行操作时的 JobID。仅当节点池处于Deleting状态时才返回该字段。

conditions

Array of NodePoolCondition objects

节点池当前详细状态列表，详情参见Condition类型定义。

type

String

Condition类型，当前支持类型如下

• "Scalable"：节点池实际的可扩容状态，如果状态为"False"时则不会再次触发节点池扩容行为。
• "QuotaInsufficient"：节点池扩容依赖的配额不足，影响节点池可扩容状态。
• "ResourceInsufficient"：节点池扩容依赖的资源不足，影响节点池可扩容状态。
• "UnexpectedError"：节点池非预期扩容失败，影响节点池可扩容状态。
• "Error"：节点池错误，通常由于删除失败触发。

status

String

Condition当前状态，取值如下

• "True"
• "False"

lastProbeTime

String

上次状态检查时间。

lastTransitTime

String

上次状态变更时间。

reason

String

上次状态变更原因。

message

String

Condition详细描述。

200

表示获取集群下所有节点池成功。