获取集群下所有节点池_云容器引擎 CCE_API参考_API_集群管理

project_id

是

String

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

cluster_id

是

String

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

errorStatus

否

String

集群状态兼容Error参数，用于API平滑切换。 兼容场景下，errorStatus为空则屏蔽Error状态为Deleting状态。

最小长度：0

最大长度：10

showDefaultNodePool

否

String

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

Content-Type

是

String

消息体的类型（格式）

缺省值：application/json

X-Auth-Token

是

String

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

最大长度：16384

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

/

kind

String

API类型，固定值“NodePool”。

缺省值：NodePool

apiVersion

String

API版本，固定值“v3”。

缺省值：v3

metadata

NodePoolMetadata object

节点池的元数据信息

spec

NodePoolSpec object

节点池的规格描述

status

NodePoolStatus object

节点池状态

name

String

节点名池名称。

最小长度：1

最大长度：50

uid

String

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

type

String

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

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

枚举值：

• vm
• ElasticBMS

nodeTemplate

V3NodeSpec object

节点池模板详细参数。

initialNodeCount

Integer

节点池初始化节点个数。

autoscaling

NodePoolNodeAutoscaling object

弹性伸缩参数。

nodeManagement

NodeManagement object

节点管理相关配置

flavor

String

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

最小长度：1

最大长度：50

az

String

待创建节点所在的可用区，需要指定可用区（AZ）的名称。CCE支持的可用区请参考地区和终端节点获取。

最大长度：200

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一致

publicIP

V3NodePublicIP object

节点的弹性公网IP

nodeNicSpec

NodeNicSpec object

节点的网卡信息

count

Integer

批量创建时节点的个数，必须为大于等于1，小于等于最大限额的正整数。作用于节点池时该项允许为0

billingMode

Integer

节点的计费模式：取值为 0（按需付费）、2（自动付费包周期）

自动付费包周期支持普通用户token。

taints

Array of Taint objects

支持给创建出来的节点加Taints来设置反亲和性，每条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>创建节点池添加节点时不支持该参数。

offloadNode

Boolean

是否CCE Turbo集群节点

userTags

Array of UserTag objects

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

runtime

Runtime object

extendParam

NodeExtendParam object

创建节点时的扩展参数。

sshKey

String

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

userPassword

UserPassword object

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

username

String

登录帐号，默认为“root”

缺省值：root

password

String

登录密码，取值请参见创建云服务器中adminPass参数的描述。若创建节点通过用户名密码方式，即使用该字段，则响应体中该字段作屏蔽展示。创建节点时password字段需要加盐加密，具体方法请参见创建节点时password字段加盐加密。

size

Integer

磁盘大小，单位为GB

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

volumetype

String

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

• SAS：高IO，是指由SAS存储提供资源的磁盘类型。
• SSD：超高IO，是指由SSD存储提供资源的磁盘类型。

extendParam

Map<String,Object>

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

cluster_id

String

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

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

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配合使用。

ids

Array of strings

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

count

Integer

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

eip

V3NodeEIPSpec object

弹性IP参数

iptype

String

弹性IP类型，取值请参见“创建云服务器 > eip字段数据结构说明”表中“iptype”参数的描述。

bandwidth

V3NodeBandwidth object

弹性IP的带宽参数

chargemode

String

带宽的计费类型：

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

size

String

带宽大小，取值请参见“创建云服务器 > bandwidth字段数据结构说明”表中“size”参数的描述。

sharetype

String

带宽的共享类型，取值请参见“创建云服务器 > bandwidth字段数据结构说明”表中“sharetype”参数的描述。

primaryNic

NicSpec object

主网卡的描述信息。

extNics

Array of NicSpec objects

扩展网卡

subnetId

String

网卡所在子网的ID。

fixedIps

Array of strings

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

ipBlock

String

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

key

String

键

value

String

值

最大长度：63

effect

String

作用效果

枚举值：

• NoSchedule
• PreferNoSchedule
• NoExecute

key

String

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

最小长度：1

最大长度：36

value

String

云服务器标签的值

最小长度：0

最大长度：43

name

String

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

缺省值：docker

枚举值：

• docker
• containerd

ecs:performancetype

String

云服务器规格的分类。裸金属节点无该字段。

orderID

String

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

productID

String

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

maxPods

Integer

节点最大允许创建的实例数(Pod)，该数量包含系统默认实例，取值范围为16~256。 该设置的目的为防止节点因管理过多实例而负载过重，请根据您的业务需要进行设置。

periodType

String

订购周期类型，取值范围：

• month：月
• year：年

periodNum

Integer

订购周期数，取值范围：

• periodType=month（周期类型为月）时，取值为[1-9]。
• periodType=year（周期类型为年）时，取值为1。

isAutoRenew

String

是否自动续订

• “true”：自动续订
• “false”：不自动续订

isAutoPay

String

是否自动扣款

• “true”：自动扣款
• “false”：不自动扣款

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初始化时间过长而启动失败，若对容器磁盘大小有特殊要求，可考虑使用挂载外部或本地存储方式代替。

offloadNode

String

是否为CCE Turbo集群节点。

publicKey

String

节点的公钥。

alpha.cce/preInstall

String

安装前执行脚本

alpha.cce/postInstall

String

安装后执行脚本

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，请根据您的需求进行配置。

enable

Boolean

是否开启自动扩缩容

缺省值：false

minNodeCount

Integer

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

最小值：0

maxNodeCount

Integer

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

最小值：0

scaleDownCooldownTime

Integer

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

最小值：0

最大值：2147483647

priority

Integer

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

serverGroupReference

String

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

currentNode

Integer

当前节点池中节点数量

phase

String

节点池状态，为空时节点池处于可用状态。

• Synchronizing：伸缩中
• Synchronized：节点池更新失败时会被置于此状态
• SoldOut：节点资源售罄
• Deleting：删除中
• Error：错误

枚举值：

• Synchronizing
• Synchronized
• SoldOut
• Deleting
• Error

jobId

String

节点池删除时的 JobID

200

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