更新时间:2026-08-21 GMT+08:00

获取指定的节点

功能介绍

该API用于通过节点ID获取指定节点的详细信息。

集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径。

调用方法

请参见如何调用API。

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/{node_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

cluster_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

node_id

是

String

参数解释:

节点ID,获取方式请参见如何获取接口URI中参数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释:

消息体的类型(格式),默认为application/json,有其他取值时会在具体接口中专门说明。

约束限制:

GET方法不做校验

默认取值:

不涉及

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

kind

String

参数解释:

API类型

约束限制:

该值不可修改

取值范围:

不涉及

默认取值:

Node

apiVersion

String

参数解释:

API版本

约束限制:

该值不可修改

取值范围:

不涉及

默认取值:

v3

metadata

NodeMetadata object

参数解释:

metadata是节点对象的元数据定义,是集合类的元素类型,包含一组由不同名称定义的属性。

约束限制:

不涉及

spec

NodeSpec object

参数解释:

spec是集合类的元素类型,用户对需要管理的节点对象进行详细描述的主体部分都在spec中给出。系统通过spec的描述来创建或更新对象。

约束限制:

不涉及

status

NodeStatus object

参数解释:

节点状态,动态记录,创建或修改时指定无意义.

约束限制:

不涉及

表4 NodeMetadata

参数

参数类型

描述

name

String

参数解释:

节点名称

约束限制:

  • 命名规则:以小写字母开头,由小写字母、数字、中划线(-)、点(.)组成,长度范围1-69位,且不能以中划线(-)结尾。

  • 若name未指定或指定为空字符串,则按照默认规则生成节点名称。默认规则为:“集群名称-随机字符串”,若集群名称过长,则只取前36个字符。

  • 若节点数量(count)大于1时,则按照默认规则会在用户输入的节点名称末尾添加随机字符串。默认规则为:“用户输入名称-随机字符串”,若用户输入的节点名称长度范围超过50位时,系统截取前50位,并在末尾添加随机字符串。

取值范围:

命名规则:以小写字母开头,由小写字母、数字、中划线(-)、点(.)组成,长度范围1-69位,且不能以中划线(-)结尾。

默认取值:

若name未指定或指定为空字符串,则按照默认规则生成节点名称。默认规则为:“集群名称-随机字符串”,若集群名称过长,则只取前36个字符。

uid

String

参数解释:

节点ID,资源唯一标识,创建成功后自动生成,填写无效

约束限制:

创建成功后自动生成,填写无效

取值范围:

不涉及

默认取值:

不涉及

annotations

Map<String,String>

参数解释:

CCE自有节点注解,非Kubernetes原生annotations,格式为key/value键值对。

说明:

Annotations不用于标识和选择对象。Annotations中的元数据可以是small或large,structured或unstructured,并且可以包括标签不允许使用的字符。

约束限制:

仅用于查询,不支持请求时传入,填写无效。

取值范围:

Annotations不用于标识和选择对象。Annotations中的元数据可以是small或large,structured或unstructured,并且可以包括标签不允许使用的字符。

默认取值:

不涉及

示例:

"annotations": {
  "key1" : "value1",
  "key2" : "value2"
}

creationTimestamp

String

参数解释:

创建时间

约束限制:

创建成功后自动生成,填写无效

取值范围:

不涉及

默认取值:

不涉及

updateTimestamp

String

参数解释:

更新时间

约束限制:

更新成功后自动生成,填写无效

取值范围:

不涉及

默认取值:

不涉及

ownerReferences

ownerReferences object

参数解释:

属主对象。

约束限制:

  • 创建成功后自动生成,填写无效。

  • 创建节点接口返回内容中无该参数

取值范围:

不涉及

默认取值:

不涉及

表5 ownerReferences

参数

参数类型

描述

nodepoolName

String

参数解释:

节点池名称

约束限制:

创建成功后自动生成,填写无效。

取值范围:

不涉及

默认取值:

不涉及

nodepoolID

String

参数解释:

节点池ID,获取方式请参见如何获取接口URI中参数。

约束限制:

创建成功后自动生成,填写无效。

取值范围:

不涉及

默认取值:

不涉及

hyperNodeName

String

参数解释:

超节点名称。如果节点不属于超节点,此字段不展示。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

hyperNodeID

String

参数解释:

超节点ID。如果节点不属于超节点,此字段不展示。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表6 NodeSpec

参数

参数类型

描述

flavor

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

az

String

参数解释:

待创建节点所在的可用区,需要指定可用区(AZ)的名称,通过api创建节点不支持随机可用区。

约束限制:

创建节点池并设置伸缩组时,该参数不允许填写为random。

取值范围:

不涉及

默认取值:

不涉及

os

String

参数解释:

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

约束限制:

  • 若在创建节点时未指定该配置,CCE会根据集群版本自动选择支持的OS版本。

  • 若当前集群版本不支持该OS类型,则会自动替换为当前集群版本支持的同系列OS类型。

  • 若在创建节点时指定了extendParam中的alpha.cce/NodeImageID参数,节点将使用私有镜像,则该参数为非必选参数。

取值范围:

不涉及

默认取值:

不涉及

login

Login object

参数解释:

节点的登录方式。不配置将保留所选择镜像的密码,为了保证您的正常使用,请确保所选择镜像中已经设置了密码。

约束限制:

不涉及

rootVolume

Volume object

参数解释:

节点的磁盘信息。

约束限制:

不涉及

dataVolumes

Array of Volume objects

参数解释:

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

约束限制:

  • 磁盘挂载上限为虚拟机不超过16块,裸金属不超过10块。在此基础上还受限于虚拟机/裸金属规格可挂载磁盘数上限。(目前支持通过控制台和API为CCE节点添加多块数据盘)。

  • 如果数据盘正供容器运行时和Kubelet组件使用,则不可被卸载,否则将导致节点不可用。

  • 仅在选择系统盘作为系统组件存储磁盘时,允许为空。

storage

Storage object

参数解释:

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

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

约束限制:

  • v1.15.11-r0及以上集群版本支持此字段。不支持集群版本填写此字段将被忽略。

  • 如存在节点规格涉及本地盘并同时使用云硬盘场景时,请勿缺省此参数,避免出现将用户未期望的磁盘分区。

  • 如希望数据盘取值范围调整至20-32768,请勿缺省此参数。

  • 如希望使用共享磁盘空间(取消runtime和kubernetes分区),请勿缺省此参数,共享磁盘空间请参考数据盘空间分配说明。

  • 如希望系统组件存储在系统盘中,请勿缺省此参数。

publicIP

NodePublicIP object

参数解释:

节点的弹性公网IP。

约束限制:

创建节点池添加节点时不支持该参数。

nodeNicSpec

NodeNicSpec object

参数解释:

节点的网卡信息。

约束限制:

不涉及

count

Integer

参数解释:

批量创建时节点的个数。

约束限制:

  • 作用于节点池时该项可以不填写。

  • 创建、更新节点池场景返回中无该参数。

  • 创建节点时该参数为必填参数

取值范围:

必须为大于等于1,小于等于最大限额的正整数。

默认取值:

不涉及

billingMode

Integer

参数解释:

节点的计费模式。

约束限制:

不涉及

取值范围:

  • 0: 按需付费

默认取值:

0

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"
}]

约束限制:

taints配置不超过20条。

waitPostInstallFinish

Boolean

参数解释:

该参数用于控制创建节点时 post-install脚本执行完成前允许节点调度 行为。当该参数未设置或者为false时,在kubernetes节点就绪时,容器即可被调度到可用节点。当该参数为true时,在kubernetes节点就绪时且post-install脚本执行完成时,容器才可被调度到可用节点。

约束限制:

不涉及

取值范围:

  • false:在kubernetes节点就绪时,容器即可被调度到可用节点。

  • true:在kubernetes节点就绪时且post-install脚本执行完成时,容器才可被调度到可用节点。

默认取值:

false

k8sTags

Map<String,String>

参数解释:

格式为key/value键值对。

  • Key:必须以字母或数字开头和结尾,可以包含字母、数字、连字符、下划线和点,最长63个字符;另外可以使用DNS子域作为前缀,例如example.com/my-key,DNS子域最长253个字符。

  • Value:可以为空或者非空字符串,非空字符串必须以字符或数字开头和结尾,可以包含字母、数字、连字符、下划线和点,最长63个字符。

字段使用场景:在节点创建场景下,支持指定初始值,查询时不返回该字段;在节点池场景下,创建节点池时节点模板参数中支持指定初始值,查询时支持返回该字段;在其余场景下,查询时都不会返回该字段。

示例:

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

约束限制:

键值对个数不超过20条。

ecsGroupId

String

参数解释:

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

约束限制:

创建、更新节点池时该配置不会生效,若要保持节点池中的节点都在同一个云服务器组内,请在节点池 nodeManagement 字段中配置。

取值范围:

不涉及

默认取值:

不涉及

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,如下所示:

  3. CCE组件轮询节点的status.Conditions,查看是否存在type为CCEInitial、CustomedInitial的condition,若存在且status字段值为True,认为节点初始化完成,则移除初始化污点;

  4. initializedConditions支持设置超时时间,用户可以在创节点时传入,如:"initializedConditions": ["CCEInitial:15m", "CustomedInitial:15m"],表示超时时间为15分钟,达到超时时间后,当CCE组件轮询到节点时会自动忽略初始化condition,移除初始化污点。

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

约束限制:

  • initializedConditions中超时时间取值范围为[1-99]秒

  • 必须以字母、数字组成,长度范围1-20位。

  • 标记数量不超过2个。

  • 超时时间仅支持分钟(m)单位。

extendParam

NodeExtendParam object

参数解释:

创建节点时的扩展参数。

约束限制:

不涉及

hostnameConfig

HostnameConfig object

参数解释:

K8S节点名称配置参数。

约束限制:

支持的集群版本为v1.23.6-r0到v1.25或者v1.25.2-r0及以上。

serverEnterpriseProjectID

String

参数解释:

服务器企业项目ID。CCE服务不实现EPS相关特性,该字段仅用于同步服务器企业项目ID。

约束限制:

创建节点/节点池场景:可指定已存在企业项目,当取值为空时,该字段继承集群企业项目属性。

更新节点池场景:配置修改后仅会对新增节点的服务器生效,存量节点需前往EPS界面迁移。

取值范围:

不涉及

默认取值:

如果更新时不指定值,不会更新该字段。

当该字段为空时,返回集群企业项目。

nodeNameTemplate

nodeNameTemplate object

参数解释:

节点名称固定前后缀配置参数。假设集群内不同节点池被用户所在公司不同部门使用,可以通过前后缀的名称区分部门和使用方式,如设置nodeNamePrefix为finance-,代表部门名称,nodeNameSuffix为-product,代表生产使用,节点池名称为gpu,代表业务类型,则最终的节点名称为finance-gpu(五位随机数)-product

约束限制:

仅 v1.28.1/v1.27.3/v1.25.6/v1.23.11/v1.21.12 及以上集群支持配置节点名称固定前后缀,该配置参数仅在节点池场景有效

取值范围:

不涉及

默认取值:

不涉及

表7 Login

参数

参数类型

描述

sshKey

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

userPassword

UserPassword object

参数解释:

选择密码方式登录时的账号密码信息,之后可通过此账号密码登录节点。

约束限制:

不涉及

removeUserPassword

Boolean

参数解释:

更新节点池时,移除当前节点池密码方式登录的配置

约束限制:

仅更新节点池场景支持该参数,设置为true时不允许设置userPassword

取值范围:

不涉及

默认取值:

false

removeSSHKey

Boolean

参数解释:

更新节点池时,移除当前节点池密钥对方式登录的配置

约束限制:

仅更新节点池场景支持该参数,设置为true时不允许设置sshKey

取值范围:

不涉及

默认取值:

false

表8 UserPassword

参数

参数类型

描述

username

String

参数解释:

登录账号,默认为“root”。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

root。

password

String

参数解释:

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

约束限制:

创建节点时password字段需要加盐加密,具体方法请参见创建节点时password字段加盐加密。

取值范围:

密码复杂度要求:

  • 长度为8-26位。

  • 密码至少必须包含大写字母、小写字母、数字和特殊字符(!@$%^-_=+[{}]:,./?)中的三种。

  • 密码不能包含用户名或用户名的逆序。

默认取值:

不涉及

表9 Volume

参数

参数类型

描述

size

Integer

参数解释:

磁盘大小,单位为GiB。

约束限制:

不涉及

取值范围:

  • 系统盘取值范围: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

参数解释:

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

约束限制:

不涉及

表10 VolumeMetadata

参数

参数类型

描述

__system__encrypted

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

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

__system__cmkid

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表11 Storage

参数

参数类型

描述

storageSelectors

Array of StorageSelectors objects

参数解释:

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

约束限制:

不涉及

storageGroups

Array of StorageGroups objects

参数解释:

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

约束限制:

不涉及

表12 StorageSelectors

参数

参数类型

描述

name

String

参数解释:

selector的名字,作为storageGroup中selectorNames的索引。

约束限制:

各个selector间的名字不能重复。

取值范围:

不涉及

默认取值:

不涉及

storageType

String

参数解释:

存储类型。

约束限制:

  • local存储类型不支持磁盘选择,所有本地盘将被组成一个VG,因此也仅允许只有一个local类型的storageSelector。

  • system存储类型不支持磁盘选择,选择系统盘作为系统组件存储磁盘。因此也仅允许只有一个system类型的storageSelector,且name必须为cceUse。

取值范围:

当前仅支持evs(云硬盘)、local(本地盘)和system(系统盘)。

默认取值:

不涉及

matchLabels

matchLabels object

参数解释:

evs盘的匹配字段。

约束限制:

storageType设置为system(系统盘)时,无需设置此字段。

取值范围:

支持DataVolume中的size、volumeType、metadataEncrypted、metadataCmkid、count字段。

默认取值:

不涉及

表13 matchLabels

参数

参数类型

描述

size

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

volumeType

String

参数解释:

云硬盘类型,目前支持SSD、GPSSD、SAS、ESSD、SATA等,不填则无云硬盘类型限制。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

metadataEncrypted

String

参数解释:

磁盘加密标识符,0代表不加密,1代表加密,不填则无磁盘加密标识符限制。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

metadataCmkid

String

参数解释:

加密磁盘的用户主密钥ID,长度为36字节的字符串,不填则无磁盘密钥ID限制。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

count

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表14 StorageGroups

参数

参数类型

描述

name

String

参数解释:

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

约束限制:

不涉及

取值范围:

  • 当cceManaged=true时,name必须为:vgpaas。

  • 当数据盘作为临时存储卷时:name必须为:vg-everest-localvolume-ephemeral。

  • 当数据盘作为持久存储卷时:name必须为:vg-everest-localvolume-persistent。

默认取值:

不涉及

cceManaged

Boolean

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

selectorNames

Array of strings

参数解释:

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

约束限制:

系统组件无法分别存储于系统盘与数据盘中,因此选择selector的type为system时,group只能选择一个selector。

virtualSpaces

Array of VirtualSpace objects

参数解释:

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

约束限制:

不涉及

表15 VirtualSpace

参数

参数类型

描述

name

String

参数解释:

virtualSpace的名称,当前仅支持四种类型:share、kubernetes、runtime、user。

约束限制:

不涉及

取值范围:

  • kubernetes:k8s空间配置,需配置lvmConfig;

  • runtime:运行时空间配置,需配置runtimeConfig;

  • user:用户空间配置,需配置lvmConfig。

默认取值:

不涉及

size

String

参数解释:

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

约束限制:

不涉及

取值范围:

该参数取值范围[10-90],一个group中所有virtualSpace的百分比之和不得超过100%

默认取值:

不涉及

lvmConfig

LVMConfig object

参数解释:

lvm配置管理,适用于share、kubernetes和user空间配置。

约束限制:

一个virtualSpace仅支持一个config配置。

runtimeConfig

RuntimeConfig object

参数解释:

runtime配置管理,适用于运行时空间配置。

约束限制:

一个virtualSpace仅支持一个config配置。

表16 LVMConfig

参数

参数类型

描述

lvType

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

path

String

参数解释:

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

约束限制:

挂载路径请填写业务目录路径,不可设置为空或根目录等操作系统关键路径。不可填写的操作系统关键路径如下:

/, /home, /home/, /bin, /bin/, /lib, /lib/, /root, /root/, /boot, /boot/, /dev, /dev/, /etc, /etc/, /lost+found, /lost+found/, /mnt, /mnt/, /proc, /proc/,/sbin, /sbin/, /srv, /srv/, /tmp, /tmp/, /var, /var/, /media, /media/, /opt, /opt/, /selinux, /selinux/, /sys, /sys/, /usr, /usr/, /opt/cloud/, /mnt/paas/, /home/paas/, /var/paas/, /var/lib/, /var/script/

取值范围:

不涉及

默认取值:

不涉及

表17 RuntimeConfig

参数

参数类型

描述

lvType

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表18 NodePublicIP

参数

参数类型

描述

ids

Array of strings

参数解释:

已有的弹性IP的ID列表。

约束限制:

  • 数量不得大于待创建节点数;

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

count

Integer

参数解释:

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

约束限制:

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

取值范围:

不涉及

默认取值:

不涉及

eip

NodeEIPSpec object

参数解释:

弹性IP参数。

约束限制:

创建节点池时不支持此参数

表19 NodeEIPSpec

参数

参数类型

描述

iptype

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

bandwidth

NodeBandwidth object

参数解释:

弹性IP的带宽参数。

约束限制:

不涉及

表20 NodeBandwidth

参数

参数类型

描述

chargemode

String

参数解释:

带宽的计费类型。

说明:
  • 按带宽计费:按公网传输速率(单位为Mbps)计费。当您的带宽利用率高于10%时,建议优先选择按带宽计费。

  • 按流量计费:只允许在创建按需节点时指定,按公网传输的数据总量(单位为GB)计费。当您的带宽利用率低于10%时,建议优先选择按流量计费。

约束限制:

不涉及

取值范围:

  • 未传该字段,表示按带宽计费。

  • 字段值为空,表示按带宽计费。

  • 字段值为“traffic”,表示按流量计费。

  • 字段为其它值,会导致创建云服务器失败。

默认取值:

不涉及

size

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sharetype

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表21 NodeNicSpec

参数

参数类型

描述

primaryNic

NicSpec object

参数解释:

主网卡的描述信息。

约束限制:

不涉及

extNics

Array of NicSpec objects

参数解释:

扩展网卡。

约束限制:

创建节点池添加节点时不支持该参数。

表22 NicSpec

参数

参数类型

描述

subnetId

String

参数解释:

网卡所在子网的网络ID。若节点池同时配置了subnetList,则节点池扩容子网以subnetList字段为准。

约束限制:

  • 主网卡创建时若未指定subnetId,将使用集群子网;

  • 扩展网卡创建时必须指定subnetId。

取值范围:

不涉及

默认取值:

不涉及

fixedIps

Array of strings

参数解释:

主网卡的IP将通过fixedIps指定,数量不得大于创建的节点数。

约束限制:

  • fixedIps或ipBlock同时只能指定一个

  • 扩展网卡不支持指定fixedIps

  • 创建节点池场景不支持该配置参数

  • 节点池场景响应内容中无该字段

ipBlock

String

参数解释:

主网卡的IP段的CIDR格式,创建的节点IP将属于该IP段内。

约束限制:

  • fixedIps或ipBlock同时只能指定一个。

  • 创建节点池场景不支持该配置参数

  • 节点池场景响应内容中无该字段

取值范围:

不涉及

默认取值:

不涉及

subnetList

Array of strings

参数解释:

网卡所在子网的网络ID列表,支持节点池配置多个子网。

约束限制:

最多支持配置20个子网。

表23 Taint

参数

参数类型

描述

key

String

参数解释:

K8s污点的键。

约束限制:

必须以字母或数字开头和结尾,可以包含字母、数字、连字符、下划线和点,最长63个字符。

取值范围:

不涉及

默认取值:

不涉及

value

String

参数解释:

K8s污点的值。

约束限制:

必须以字母或数字开头和结尾,可以包含字母、数字、连字符、下划线和点,最长63个字符。

取值范围:

不涉及

默认取值:

不涉及

effect

String

参数解释:

K8s污点的作用效果。

约束限制:

不涉及

取值范围:

只可选NoSchedule,PreferNoSchedule或NoExecute。

默认取值:

不涉及

表24 UserTag

参数

参数类型

描述

key

String

参数解释:

云服务器标签的键。

约束限制:

不得以"CCE-"、"__type_baremetal"或"_sys_"开头。

取值范围:

标签键不能重复,首尾不能为空,不能包含特殊字符"=","*",“<”,“>”,“\”,“,”,“|”,“/”,不能包含非打印字符ASCII(0-31),长度不超过128个字符。

默认取值:

不涉及

value

String

参数解释:

云服务器标签的值。

约束限制:

不涉及

取值范围:

标签值首尾不能为空,不能包含特殊字符"=","*",“<”,“>”,“\”,“,”,“|”,不能包含非打印字符ASCII(0-31),长度不超过255个字符。

默认取值:

不涉及

表25 Runtime

参数

参数类型

描述

name

String

参数解释:

容器运行时。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

  • v1.25以下集群:默认为"docker";

  • v1.25及以上集群,随操作系统变化,默认的容器运行时不同;

  • 操作系统为EulerOS 2.5的节点默认为"docker",其余操作系统的节点默认为"containerd"。

runtimeClass

String

参数解释:

容器运行时子类别。

约束限制:

仅CCE Turbo集群下弹性云服务器-物理机类型节点且上级运行时为containerd场景支持使用安全运行时。

取值范围:

  • runc: 普通运行时。

  • kata: 安全运行时,需配套c6、c7系列弹性云服务器-物理机,支持操作系统为EulerOS 2.10。

  • kuasar-vmm: 安全运行时v2,支持操作系统为HCE 2.0,集群版本需为v1.28.15-r70、v1.29.15-r30、v1.30.14-r30、v1.31.10-r30、v1.32.6-r30、v1.33.5-r20或以上版本。

默认取值:

runc

表26 NodeExtendParam

参数

参数类型

描述

ecs:performancetype

String

参数解释:

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

约束限制:

不涉及

取值范围:

请参考ECS API参考手册中“查询规格详情和规格扩展信息列表”接口的ecs:performancetype参数说明,以了解云服务器的规格类型。

默认取值:

不涉及

maxPods

Integer

参数解释:

节点最大允许创建的实例数(Pod),该数量包含系统默认实例。

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

节点可以创建多少个Pod,受多个参数影响,具体请参见节点可创建的最大Pod数量说明。

约束限制:

不涉及

取值范围:

通用取值范围为16~256,节点运行时子类别为安全运行时v2(kuasar-vmm)场景取值范围为16~1024。

默认取值:

不涉及

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

参数解释:

节点上单容器的可用磁盘空间大小(已废弃,请优先使用containerBaseSize参数),单位G。

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

约束限制:

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

  • dockerBaseSize设置仅在v1.19.16-r0、v1.21.3-r0、v1.23.3-r0及以上的集群版本中的EulerOS/HCEOS2.0节点上生效。

取值范围:

10-500。

默认取值:

不配置该值或值为0时将使用默认值:

  • Devicemapper模式下默认值为10;

  • OverlayFS模式默认不限制单容器可用空间大小。

containerBaseSize

Integer

参数解释:

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

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

约束限制:

  • Devicemapper模式下建议containerBaseSize配置不超过80G,设置过大时可能会导致容器运行时初始化时间过长而启动失败,若对容器磁盘大小有特殊要求,可考虑使用挂载外部或本地存储方式代替;Devicemapper模式在新版中仅有共池裸机使用,已逐步废弃。

  • containerBaseSize设置仅在新版本集群(v1.23.14-r0/v1.25.9-r0/v1.27.6-r0/v1.28.4-r0及以上)的EulerOS/HCEOS2.0节点上生效。

  • 更新节点池时,不支持更新此参数。

取值范围:

10-500。

默认取值:

不配置该值或值为0时将使用默认值:

  • Devicemapper模式下默认值为10;

  • OverlayFS模式默认不限制单容器可用空间大小。

publicKey

String

参数解释:

节点的公钥,应用于ssh密钥登录。

约束限制:

  • 当选择使用密钥对方式登录节点时该配置无效

  • 创建、更新节点池场景不支持该参数

取值范围:

不涉及

默认取值:

不涉及

alpha.cce/preInstall

String

参数解释:

安装前执行脚本。

输入的值需要经过Base64编码,方法如下:

echo -n "待编码内容" | base64

约束限制:

安装前/后执行脚本统一计算字符,转码后的字符总数不能超过10240。

取值范围:

不涉及

默认取值:

不涉及

alpha.cce/postInstall

String

参数解释:

安装后执行脚本。

输入的值需要经过Base64编码,方法如下:

echo -n "待编码内容" | base64

约束限制:

安装前/后执行脚本统一计算字符,转码后的字符总数不能超过10240。

取值范围:

不涉及

默认取值:

不涉及

alpha.cce/NodeImageID

String

参数解释:

节点自定义镜像ID,从IMS控制台获取,需要使用自定义镜像时使用此参数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

chargingMode

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

agency_name

String

参数解释:

委托的名称。

委托是由租户管理员在统一身份认证服务(Identity and Access Management,IAM)上创建的,可以为CCE节点提供访问云服务器的临时凭证。

作为响应参数仅在创建节点传入时返回该字段。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

kubeReservedMem

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

systemReservedMem

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

kubeReservedCpu

Integer

参数解释:

节点CPU预留,Kubernetes相关组件预留值。单位为mcore。

约束限制:

kubeReservedCpu,systemReservedCpu之和小于节点池中节点最小CPU规格的50%。

取值范围:

不涉及

默认取值:

不涉及

systemReservedCpu

Integer

参数解释:

节点CPU预留,系统组件预留值。单位为mcore。

约束限制:

kubeReservedCpu,systemReservedCpu之和小于节点池中节点最小CPU规格的50%。

取值范围:

不涉及

默认取值:

不涉及

kubeReservedPid

Integer

参数解释:

节点PID预留,Kubernetes相关组件预留值。目的是为Kubernetes系统守护进程(如kubelet、container runtime等)预留指定数量的进程ID。

约束限制:

kubeReservedPid,systemReservedPid之和小于linux PID数量上限的50%。

取值范围:

[0,2097152] 注:CCE仅校验kernel.pid_max为4194304的场景,2022年1月30日及之前创建的节点和部分OS的kernel.pid_max会有所不同,若您更新过kernel.pid_max也需要保证kubeReservedPid,systemReservedPid之和小于linux PID数量上限。

默认取值:

不涉及

systemReservedPid

Integer

参数解释:

节点PID预留,系统组件预留值。目的是为OS系统守护进程(如 sshd、udev 等)预留指定数量的进程ID。

约束限制:

kubeReservedPid,systemReservedPid之和小于linux PID数量上限的50%。

取值范围:

[0,2097152] 注:CCE仅校验kernel.pid_max为4194304的场景,2022年1月30日及之前创建的节点和部分OS的kernel.pid_max会有所不同,若您更新过kernel.pid_max也需要保证kubeReservedPid,systemReservedPid之和小于linux PID数量上限。

默认取值:

不涉及

kubeReservedStorage

Integer

参数解释:

节点临时存储空间预留,Kubernetes组件预留值。目的是为Kubernetes系统守护进程(如kubelet、container runtime等)预留临时存储。单位为Gi。

约束限制:

kubeReservedStorage,systemReservedStorage之和小于容器组件所使用硬盘空间的50%。

取值范围:

不涉及

默认取值:

不涉及

systemReservedStorage

Integer

参数解释:

节点临时存储空间预留,系统组件预留值。目的是为OS系统守护进程(如 sshd、udev 等)预留临时存储。单位为Gi。

约束限制:

kubeReservedStorage,systemReservedStorage之和小于容器组件所使用硬盘空间的50%。

取值范围:

不涉及

默认取值:

不涉及

init-node-password

String

参数解释:

节点密码,仅作为响应参数时,固定展示星号,节点池场景响应返回中无该参数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表27 HostnameConfig

参数

参数类型

描述

type

String

参数解释:

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

约束限制:

  • 配置为cceNodeName的节点, 其节点名称、K8S节点名称以及虚机名称相同。节点名称不支持修改, 并且在ECS侧修改了虚机名称,同步云服务器时,不会将修改后的虚机名称同步到节点。

  • 配置为cceNodeName的节点,为了避免K8S节点名称冲突,系统会自动在节点名称后添加后缀,后缀的格式为中划线(-)+五位随机字符,随机字符的取值为[a-z0-9]。

取值范围:

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

  • cceNodeName: 将CCE节点名称作为K8S节点名称

默认取值:

默认为“privateIp”。

表28 nodeNameTemplate

参数

参数类型

描述

nodeNamePrefix

String

参数解释:

节点名称前缀。如果用户填写为空串或缺省,则节点名称不会增加前缀。

约束限制:

仅支持小写字母、数字、连字符(-)和点(.),必须以小写字母开头,并且符合FRC 1123中定义的DNS子域名命名规范。

取值范围:

不涉及

默认取值:

不涉及

nodeNameSuffix

String

参数解释:

节点名称后缀。如果用户填写为空串或缺省,则节点名称不会增加后缀。

约束限制:

仅支持小写字母、数字、连字符(-)和点(.),后缀结尾必须为小写字母或者数字,并且符合FRC 1123中定义的DNS子域名命名规范。

取值范围:

不涉及

默认取值:

不涉及

表29 NodeStatus

参数

参数类型

描述

phase

String

参数解释:

节点状态:节点资源生命周期管理(如安装卸载等)状态和集群内k8s node状态的综合体现

约束限制:

创建节点接口返回中无该参数。

取值范围:

节点资源生命周期管理(如安装卸载等)状态和集群内K8s node状态的综合体现,取值如下

  • Build:创建中,表示节点正处于创建过程中。

  • Installing:安装中,表示节点正处于纳管过程中。

  • Upgrading:升级中,表示节点正处于升级过程中。

  • Active:运行中,表示节点处于正常状态。

  • Abnormal:不可用,表示节点处于异常状态。

  • Deleting: 删除中,表示节点正处于删除过程中。

  • Error:错误,表示节点处于故障状态。

默认取值:

不涉及

lastProbeTime

String

参数解释:

节点最近一次状态检查时间。集群处于异常、冻结或者中间态(例如创建中)时,节点的状态检查动作可能受影响。检查时间超过5分的节点状态不具有参考意义。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

jobID

String

参数解释:

创建或删除时的任务ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

serverId

String

参数解释:

底层云服务器或裸金属节点ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

privateIP

String

参数解释:

节点主网卡私有网段IP地址。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

privateIPv6IP

String

参数解释:

节点主网卡私有网段IPv6地址。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

publicIP

String

参数解释:

节点弹性公网IP地址。如果ECS的数据没有实时同步,可在界面上通过“同步节点信息”手动进行更新。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

deleteStatus

DeleteStatus object

参数解释:

删除资源时表示资源删除状态

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

configurationUpToDate

Boolean

参数解释:

节点配置是否与所属节点池的节点模板最新配置一致。

当更新节点池os或runtime后,该节点池中存量节点的os或runtime便与节点池存在差异,configurationUpToDate参数值即为false。

重置节点后,存量节点的os和runtime与节点池配置保持一致,configurationUpToDate参数值即为true。

约束限制:

创建、更新节点接口返回中无该参数。

取值范围:

不涉及

默认取值:

不涉及

表30 DeleteStatus

参数

参数类型

描述

previous_total

Integer

参数解释:

集群删除时已经存在的集群资源记录总数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

current_total

Integer

参数解释:

基于当前集群资源记录信息,生成实际最新资源记录总数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

updated

Integer

参数解释:

集群删除时更新的资源记录总数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

added

Integer

参数解释:

集群删除时更新的资源记录总数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

deleted

Integer

参数解释:

集群删除时删除的资源记录总数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

无

响应示例

状态码:200

表示获取集群下指定的节点成功。

{
  "kind" : "Node",
  "apiVersion" : "v3",
  "metadata" : {
    "name" : "myhost",
    "uid" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
    "creationTimestamp" : "2018-08-02 08:12:40.124294439 +0000 UTC",
    "updateTimestamp" : "2018-08-02 08:18:20.221871842 +0000 UTC",
    "annotations" : {
      "kubernetes.io/node-pool.id" : "az1.dc1#s1.medium#EulerOS 2.2"
    }
  },
  "spec" : {
    "flavor" : "s1.medium",
    "az" : "******",
    "os" : "EulerOS 2.2",
    "login" : {
      "sshKey" : "KeyPair-001"
    },
    "rootVolume" : {
      "volumetype" : "SAS",
      "size" : 40
    },
    "dataVolumes" : [ {
      "volumetype" : "SAS",
      "size" : 100
    } ],
    "publicIP" : {
      "eip" : {
        "bandwidth" : { }
      }
    },
    "billingMode" : 0
  },
  "status" : {
    "phase" : "Active",
    "serverId" : "456789abc-9368-46f3-8f29-d1a95622a568",
    "publicIP" : "10.34.56.78",
    "privateIP" : "192.168.1.23"
  }
}

状态码

状态码

描述

200

表示获取集群下指定的节点成功。

错误码

请参见错误码。