文档首页> 云容器引擎 CCE> API参考> API> 节点池管理> 获取集群下所有节点池
更新时间:2022-05-10 GMT+08:00
分享

获取集群下所有节点池

功能介绍

该API用于获取集群下所有节点池。

  • 集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径
  • nodepool是集群中具有相同配置的节点实例的子集。

调试

您可以在API Explorer中调试该接口。

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

cluster_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

showDefaultNodePool

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式)

X-Auth-Token

String

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

kind

String

API type. The value is fixed to List.

apiVersion

String

API version. The value is fixed to v3.

items

Array of NodePool objects

/

表5 NodePool

参数

参数类型

描述

kind

String

API类型,固定值“NodePool”。

apiVersion

String

API版本,固定值“v3”。

metadata

NodePoolMetadata object

节点池的元数据信息

spec

NodePoolSpec object

节点池的规格描述

status

NodePoolStatus object

节点池状态

表6 NodePoolMetadata

参数

参数类型

描述

name

String

节点名池名称。

说明:

命名规则:

  • 以小写字母开头,由小写字母、数字、中划线(-)组成,长度范围1-50位,且不能以中划线(-)结尾。
  • 不允许创建名为 DefaultPool 的节点池。

uid

String

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

annotations

Map<String,String>

节点池的注解,以key value对表示。

updateTimestamp

String

更新时间

creationTimestamp

String

创建时间

表7 NodePoolSpec

参数

参数类型

描述

type

String

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

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

nodeTemplate

NodeSpec object

节点池模板详细参数。

initialNodeCount

Integer

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

autoscaling

NodePoolNodeAutoscaling object

弹性伸缩参数。

nodeManagement

NodeManagement object

节点管理相关配置

podSecurityGroups

Array of SecurityID objects

安全组相关配置。

表8 NodeSpec

参数

参数类型

描述

flavor

String

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

az

String

待创建节点所在的可用区,需要指定可用区(AZ)的名称。 CCE支持的可用区请参考地区和终端节点

os

String

节点的操作系统类型。

  • 对于虚拟机节点,可以配置为“EulerOS”、“CentOS”、“Debian”、“Ubuntu”。默认为"EulerOS"。
说明:

系统会根据集群版本自动选择支持的系统版本。当前集群版本不支持该系统类型,则会报错。

  • 对于自动付费包周期的裸金属节点,只支持EulerOS 2.3、EulerOS 2.5、EulerOS 2.8。
  • 若在创建节点时指定了extendParam中的alpha.cce/NodeImageID参数,可以不填写此参数。

login

Login object

节点的登录方式

rootVolume

Volume object

节点的磁盘信息

dataVolumes

Array of Volume objects

节点的数据盘参数(目前已支持通过控制台为CCE节点添加第二块数据盘)。

针对专属云节点,参数解释与rootVolume一致

storage

Storage object

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

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

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

publicIP

NodePublicIP object

节点的弹性公网IP

nodeNicSpec

NodeNicSpec object

节点的网卡信息

count

Integer

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

billingMode

Integer

节点的计费模式:取值为 0(按需付费)、1(包周期)、2(已废弃:自动付费包周期)

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上。\n>创建节点池添加节点时不支持该参数。

userTags

Array of UserTag objects

云服务器标签,键必须唯一,CCE支持的最大用户自定义标签数量依region而定,自定义标签数上限为8个。

runtime

Runtime object

容器运行时,默认为“docker”。

extendParam

NodeExtendParam object

创建节点时的扩展参数。

表9 Login

参数

参数类型

描述

sshKey

String

选择密钥对方式登录时的密钥对名称。密钥对和密码登录方式二者必选其一。

userPassword

UserPassword object

选择密码方式登录时的帐号密码信息,之后可通过此帐号密码登录节点。密钥对和密码登录方式二者必选其一。

表10 UserPassword

参数

参数类型

描述

username

String

登录帐号,默认为“root”

password

String

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

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

参数

参数类型

描述

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。

获取方法请参见获取单个专属分布式存储池详情中“表3 响应参数”的ID字段。

cluster_type

String

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

hw:passthrough

Boolean

此字段CCE将保持透传策略,实际规格约束请参考ECS创建云服务器hw:passthrough字段说明。

  • 使用SDI规格创建虚拟机时请关注该参数,如果该参数值为true,说明创建的为SCSI类型的卷

    SDI规格ECS场景包含c6x_4、c6ie_4、c7等规格

  • 节点类型为ElasticBMS时,此参数必须填写为true

metadata

VolumeMetadata object

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

表12 VolumeMetadata

参数

参数类型

描述

__system__encrypted

String

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

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

__system__cmkid

String

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

表13 Storage

参数

参数类型

描述

storageSelectors

Array of StorageSelectors objects

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

storageGroups

Array of StorageGroups objects

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

表14 StorageSelectors

参数

参数类型

描述

name

String

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

storageType

String

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

matchLabels

matchLabels object

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

表15 matchLabels

参数

参数类型

描述

size

String

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

volumeType

String

云硬盘类型,目前支持SSD\GPSSD\SAS三种。

metadataEncrypted

String

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

metadataCmkid

String

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

count

String

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

表16 StorageGroups

参数

参数类型

描述

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中空间配置的详细管理。

表17 VirtualSpace

参数

参数类型

描述

name

String

virtualSpace的名称,当前仅支持三种类型:kubernetes、runtime、user。kubernetes:k8s空间配置,需配置lvmConfig;runtime:运行时空间配置,需配置runtimeConfig;user:用户空间配置,需配置lvmConfig

size

String

virtualSpace的大小,仅支持整数百分比。例如:90%。 需要注意:一个group中所有virtualSpace的百分比之和不得超过100%

lvmConfig

LVMConfig object

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

runtimeConfig

RuntimeConfig object

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

表18 LVMConfig

参数

参数类型

描述

lvType

String

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

path

String

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

表19 RuntimeConfig

参数

参数类型

描述

lvType

String

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

表20 NodePublicIP

参数

参数类型

描述

ids

Array of strings

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

说明:

若已配置ids参数,则无需配置count和eip参数

count

Integer

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

说明:

count参数与eip参数必须同时配置。

eip

NodeEIPSpec object

弹性IP参数

表21 NodeEIPSpec

参数

参数类型

描述

iptype

String

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

bandwidth

NodeBandwidth object

弹性IP的带宽参数

表22 NodeBandwidth

参数

参数类型

描述

chargemode

String

带宽的计费类型:

  • 未传该字段,表示按带宽计费。 - 字段值为空,表示按带宽计费。
  • 字段值为“traffic”,表示按流量计费。
  • 字段为其它值,会导致创建云服务器失败。
说明:
  • 按带宽计费:按公网传输速率(单位为Mbps)计费。当您的带宽利用率高于10%时,建议优先选择按带宽计费。
  • 按流量计费:只允许在创建按需节点时指定,按公网传输的数据总量(单位为GB)计费。当您的带宽利用率低于10%时,建议优先选择按流量计费。

size

Integer

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

sharetype

String

带宽的共享类型,共享类型枚举:PER,表示独享。WHOLE,表示共享。

表23 NodeNicSpec

参数

参数类型

描述

primaryNic

NicSpec object

主网卡的描述信息。

extNics

Array of NicSpec objects

扩展网卡

表24 NicSpec

参数

参数类型

描述

subnetId

String

网卡所在子网的ID。

fixedIps

Array of strings

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

ipBlock

String

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

表25 Taint

参数

参数类型

描述

key

String

value

String

effect

String

作用效果

表26 UserTag

参数

参数类型

描述

key

String

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

value

String

云服务器标签的值

表27 Runtime

参数

参数类型

描述

name

String

容器运行时,默认为“docker”

表28 NodeExtendParam

参数

参数类型

描述

ecs:performancetype

String

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

orderID

String

订单ID,节点付费类型为自动付费包周期类型时,响应中会返回此字段。

productID

String

产品ID,节点付费类型为自动付费包周期类型时,响应中会返回此字段。

maxPods

Integer

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

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

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

periodType

String

  • month:月
  • year:年
说明:

billingMode为1(包周期)或2(已废弃:自动付费包周期)时生效,且为必选。

periodNum

Integer

订购周期数,取值范围:

  • periodType=month(周期类型为月)时,取值为[1-9]。
  • periodType=year(周期类型为年)时,取值为1。
说明:

billingMode为1或2(已废弃)时生效,且为必选。

isAutoRenew

String

是否自动续订

  • “true”:自动续订
  • “false”:不自动续订
说明:

billingMode为1或2(已废弃)时生效,不填写此参数时默认不会自动续费。

isAutoPay

String

是否自动扣款

  • “true”:自动扣款
  • “false”:不自动扣款
说明:

billingMode为1或2(已废弃)时生效,billingMode为1时不填写此参数时默认不会自动扣款。(已废弃:billingMode为2时不填写此参数时默认会自动扣款)

DockerLVMConfigOverride

String

Docker数据盘配置项。默认配置示例如下:

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

包含如下字段:

  • 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

Device mapper模式下,节点上Docker单容器的可用磁盘空间大小,OverlayFS模式(CCE Turbo集群中CentOS 7.6和Ubuntu 18.04节点,以及混合集群中Ubuntu 18.04节点)下不支持此字段。Device mapper模式下建议dockerBaseSize配置不超过80G,设置过大时可能会导致docker初始化时间过长而启动失败,若对容器磁盘大小有特殊要求,可考虑使用挂载外部或本地存储方式代替。

publicKey

String

节点的公钥。

alpha.cce/preInstall

String

安装前执行脚本

说明:

输入的值需要经过Base64编码,方法为echo -n "待编码内容" | base64

alpha.cce/postInstall

String

安装后执行脚本

说明:

输入的值需要经过Base64编码,方法为echo -n "待编码内容" | base64。

alpha.cce/NodeImageID

String

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

nicMultiqueue

String

  • 弹性网卡队列数配置,默认配置示例如下:
"[{\"queue\":4}]"

包含如下字段:

  • queue: 弹性网卡队列数。
  • 仅在turbo集群的BMS节点时,该字段才可配置。
  • 当前支持可配置队列数以及弹性网卡数:{"1":128, "2":92, "4":92, "8":32, "16":16, "28":9}, 既1弹性网卡队列可绑定128张弹性网卡,2队列弹性网卡可绑定92张,以此类推。
  • 弹性网卡队列数越多,性能越强,但可绑定弹性网卡数越少,请根据您的需求进行配置(创建后不可修改)。

nicThreshold

String

  • 弹性网卡预绑定比例配置,默认配置示例如下:
"0.3:0.6"
  • 第一位小数:预绑定低水位,弹性网卡预绑定的最低比例(最小预绑定弹性网卡数 = ⌊节点的总弹性网卡数 * 预绑定低水位⌋)
  • 第二位小数:预绑定高水位,弹性网卡预绑定的最高比例(最大预绑定弹性网卡数 = ⌊节点的总弹性网卡数 * 预绑定高水位⌋)
  • BMS节点上绑定的弹性网卡数:Pod正在使用的弹性网卡数 + 最小预绑定弹性网卡数 < BMS节点上绑定的弹性网卡数 < Pod正在使用的弹性网卡数 + 最大预绑定弹性网卡数
  • BMS节点上当预绑定弹性网卡数 < 最小预绑定弹性网卡数时:会绑定弹性网卡,使得预绑定弹性网卡数 = 最小预绑定弹性网卡数
  • BMS节点上当预绑定弹性网卡数 > 最大预绑定弹性网卡数时:会定时解绑弹性网卡(约2分钟一次),直到预绑定弹性网卡数 = 最大预绑定弹性网卡数
  • 取值范围:[0.0, 1.0]; 一位小数; 低水位 <= 高水位
  • 仅在turbo集群的BMS节点时,该字段才可配置。
  • 弹性网卡预绑定能加快工作负载的创建,但会占用IP,请根据您的需求进行配置。

enterprise_project_id

String

节点所属的企业项目id。

chargingMode

Integer

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

表29 NodePoolNodeAutoscaling

参数

参数类型

描述

enable

Boolean

是否开启自动扩缩容

minNodeCount

Integer

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

maxNodeCount

Integer

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

scaleDownCooldownTime

Integer

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

priority

Integer

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

表30 NodeManagement

参数

参数类型

描述

serverGroupReference

String

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

表31 SecurityID

参数

参数类型

描述

id

String

安全组ID。

表32 NodePoolStatus

参数

参数类型

描述

currentNode

Integer

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

creatingNode

Integer

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

deletingNode

Integer

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

phase

String

节点池状态。

  • 空值:可用(节点池当前节点数已达到预期,且无伸缩中的节点)
  • Synchronizing:伸缩中(节点池当前节点数未达到预期,且无伸缩中的节点)
  • Synchronized:伸缩等待中(节点池当前节点数未达到预期,或者存在伸缩中的节点)
  • SoldOut:节点池当前不可扩容(兼容字段,标记节点池资源售罄、资源配额不足等不可扩容状态)
说明:

上述节点池状态已废弃,仅兼容保留,不建议使用,替代感知方式如下:

  • 节点池扩缩状态:可通过currentNode/creatingNode/deletingNode节点状态统计信息,精确感知当前节点池扩缩状态。
  • 节点池可扩容状态:可通过conditions感知节点池详细状态,其中"Scalable"可替代SoldOut语义。
  • Deleting:删除中
  • Error:错误

jobId

String

对节点池执行操作时的 JobID。

conditions

Array of NodePoolCondition objects

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

表33 NodePoolCondition

参数

参数类型

描述

type

String

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

  • "Scalable":节点池实际的可扩容状态,如果状态为"False"时则不会再次触发节点池扩容行为。
  • "QuotaInsufficient":节点池扩容依赖的配额不足,影响节点池可扩容状态。
  • "ResourceInsufficient":节点池扩容依赖的资源不足,影响节点池可扩容状态。
  • "UnexpectedError":节点池非预期扩容失败,影响节点池可扩容状态。
  • "LockedByOrder":包周期节点池被订单锁定,此时Reason为待支付订单ID。
  • "Error":节点池错误,通常由于删除失败触发。

status

String

Condition当前状态,取值如下

  • "True"
  • "False"

lastProbeTime

String

上次状态检查时间。

lastTransitTime

String

上次状态变更时间。

reason

String

上次状态变更原因。

message

String

Condition详细描述。

请求示例

响应示例

状态码: 200

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

{
  "kind" : "List",
  "apiVersion" : "v3",
  "items" : [ {
    "kind" : "NodePool",
    "apiVersion" : "v3",
    "metadata" : {
      "name" : "az1.dc1#s1.large#EulerOS 2.2",
      "uid" : "az1.dc1#s1.large#EulerOS 2.2"
    },
    "spec" : {
      "nodeTemplate" : {
        "flavor" : "s1.large",
        "az" : "az1.dc1",
        "os" : "EulerOS 2.2",
        "login" : {
          "userPassword" : { }
        },
        "rootVolume" : { },
        "publicIP" : {
          "eip" : {
            "bandwidth" : { }
          }
        },
        "billingMode" : 0
      },
      "autoscaling" : {
        "enable" : true,
        "maxNodeCount" : 50
      }
    },
    "status" : {
      "currentNode" : 1
    }
  } ]
}

状态码

状态码

描述

200

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

错误码

请参见错误码

分享:

    相关文档

    相关产品

close