文档首页/ 云容器引擎 CCE/ API参考 (巴黎区域) / API/ 节点管理/ 创建节点

更新时间：2023-07-03 GMT+08:00

查看PDF

创建节点

功能介绍

该API用于在指定集群下创建节点。

若无集群，请先创建集群。
集群管理的URL格式为：https://Endpoint/uri。其中uri为资源路径，也即API访问的路径。

接口约束

仅支持创建KVM虚拟化类型的节点，非KVM虚拟化类型的节点创建后无法正常使用。

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见如何获取接口URI中参数。
cluster_id	是	String	集群ID，获取方式请参见如何获取接口URI中参数。

表2 Query参数
参数	是否必选	参数类型	描述
nodepoolScaleUp	否	String	标明是否为nodepool下发的请求。若不为“NodepoolScaleUp”将自动更新对应节点池的实例数

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	消息体的类型（格式）
X-Auth-Token	是	String	调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。

表4 请求Body参数
参数	是否必选	参数类型	描述
kind	是	String	API类型，固定值“Node”，该值不可修改。
apiVersion	是	String	API版本，固定值“v3”，该值不可修改。
metadata	否	NodeMetadata object	metadata是节点对象的元数据定义，是集合类的元素类型，包含一组由不同名称定义的属性。
spec	是	NodeSpec object	spec是集合类的元素类型，用户对需要管理的节点对象进行详细描述的主体部分都在spec中给出。系统通过spec的描述来创建或更新对象。

表5 NodeMetadata
参数	是否必选	参数类型	描述
name	否	String	节点名称说明：命名规则：以小写字母开头，由小写字母、数字、中划线(-)组成，长度范围1-56位，且不能以中划线(-)结尾。若name未指定或指定为空字符串，则按照默认规则生成节点名称。默认规则为：“集群名称-随机字符串”，若集群名称过长，则只取前36个字符。若节点数量(count)大于1时，则按照默认规则会在用户输入的节点名称末尾添加随机字符串。默认规则为：“用户输入名称-随机字符串”，若用户输入的节点名称长度范围超过50位时，系统截取前50位，并在末尾添加随机字符串。
uid	否	String	节点ID，资源唯一标识，创建成功后自动生成，填写无效
labels	否	Map<String,String>	CCE自有节点标签，非Kubernetes原生labels。标签可用于选择对象并查找满足某些条件的对象集合，格式为key/value键值对。示例： "labels": { "key" : "value" }
annotations	否	Map<String,String>	CCE自有节点注解，非Kubernetes原生annotations，格式为key/value键值对。示例： "annotations": { "key1" : "value1", "key2" : "value2" } 说明： Annotations不用于标识和选择对象。Annotations中的元数据可以是small或large，structured或unstructured，并且可以包括标签不允许使用的字符。仅用于查询，不支持请求时传入，填写无效。
creationTimestamp	否	String	创建时间，创建成功后自动生成，填写无效
updateTimestamp	否	String	更新时间，创建成功后自动生成，填写无效

表6 NodeSpec
参数	是否必选	参数类型	描述
flavor	是	String	节点的规格，CCE支持的节点规格请参考节点规格说明获取。
az	是	String	待创建节点所在的可用区，需要指定可用区（AZ）的名称。
os	否	String	节点的操作系统类型。具体支持的操作系统请参见节点操作系统说明。说明：系统会根据集群版本自动选择支持的系统版本。当前集群版本不支持该系统类型，则会报错。若在创建节点时指定了extendParam中的alpha.cce/NodeImageID参数，可以不填写此参数。
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个。字段使用场景：在节点创建场景下，支持指定初始值，查询时不返回该字段；在节点池场景下，其中节点模板中支持指定初始值，查询时支持返回该字段；在其余场景下，查询时都不会返回该字段。说明：标签键只能包含大写字母.小写字母、数字和特殊字符(-_)以及Unicode字符，长度不超过36个字符。
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调度到节点上。 cce支持自定义初始化标记，在接收到initializedConditions参数后，会将参数值转换成节点标签，随节点下发，例如：cloudprovider.openvessel.io/inject-initialized-conditions=CCEInitial_CustomedInitial。当节点上设置了此标签，会轮询节点的status.Conditions，查看conditions的type是否存在标记名，如CCEInitial、CustomedInitial标记，如果存在所有传入的标记，且状态为True，认为节点初始化完成，则移除初始化污点。必须以字母、数字组成，长度范围1-20位。标记数量不超过2个
extendParam	否	NodeExtendParam object	创建节点时的扩展参数。

表7 Login
参数	是否必选	参数类型	描述
sshKey	否	String	选择密钥对方式登录时的密钥对名称。

表8 UserPassword
参数	是否必选	参数类型	描述
username	否	String	登录帐号，默认为“root”
password	是	String	登录密码，若创建节点通过用户名密码方式，即使用该字段，则响应体中该字段作屏蔽展示。密码复杂度要求：长度为8-26位。密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?~#*）中的三种。密码不能包含用户名或用户名的逆序。创建节点时password字段需要加盐加密，具体方法请参见创建节点时password字段加盐加密。

表9 Volume
参数	是否必选	参数类型	描述
size	是	Integer	磁盘大小，单位为GB 系统盘取值范围：40~1024
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	存储类型，当前仅支持evs（云硬盘）或local（本地盘）；local存储类型不支持磁盘选择，所有本地盘将被组成一个VG，因此也仅允许只有一个local类型的storageSelector。
matchLabels	否	matchLabels object	evs盘的匹配字段，支持DataVolume中的size、volumeType、metadataEncrypted、metadataCmkid、count五个字段。

**表13** matchLabels
参数	是否必选	参数类型	描述
size	否	String	匹配的磁盘大小，不填则无磁盘大小限制。例如：100.
volumeType	否	String	云硬盘类型，目前支持SSD\GPSSD\SAS三种。
metadataEncrypted	否	String	磁盘加密标识符，0代表不加密，1代表加密。
metadataCmkid	否	String	加密磁盘的用户主密钥ID，长度为36字节的字符串。
count	否	String	磁盘选择个数，不填则选择所有此类磁盘。

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

**表15** 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配置。

**表16** LVMConfig
参数	是否必选	参数类型	描述
lvType	是	String	LVM写入模式：linear、striped。linear：线性模式；striped：条带模式，使用多块磁盘组成条带模式，能够提升磁盘性能。
path	否	String	磁盘挂载路径。仅在用户配置中生效。支持包含：数字、大小写字母、点、中划线、下划线的绝对路径。

**表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	带宽的计费类型：未传该字段，表示按带宽计费。 - 字段值为空，表示按带宽计费。字段值为“traffic”，表示按流量计费。字段为其它值，会导致创建云服务器失败。说明：按带宽计费：按公网传输速率（单位为Mbps）计费。当您的带宽利用率高于10%时，建议优先选择按带宽计费。按流量计费：只允许在创建按需节点时指定，按公网传输的数据总量（单位为GB）计费。当您的带宽利用率低于10%时，建议优先选择按流量计费。
size	否	Integer	带宽大小，取值请参见取值请参见申请EIP接口中bandwidth.size说明。
sharetype	否	String	带宽的共享类型，共享类型枚举：PER，表示独享，目前仅支持独享。

**表21** NodeNicSpec
参数	是否必选	参数类型	描述
primaryNic	否	NicSpec object	主网卡的描述信息。
extNics	否	Array of NicSpec objects	扩展网卡说明：创建节点池添加节点时不支持该参数。

**表22** NicSpec
参数	是否必选	参数类型	描述
subnetId	否	String	网卡所在子网的网络ID。主网卡创建时若未指定subnetId,将使用集群子网。扩展网卡创建时必须指定subnetId。
fixedIps	否	Array of strings	主网卡的IP将通过fixedIps指定，数量不得大于创建的节点数。fixedIps或ipBlock同时只能指定一个。扩展网卡不支持指定fiexdIps。
ipBlock	否	String	主网卡的IP段的CIDR格式，创建的节点IP将属于该IP段内。fixedIps或ipBlock同时只能指定一个。

**表23** Taint
参数	是否必选	参数类型	描述
key	是	String	键
value	否	String	值
effect	是	String	作用效果

**表24** UserTag
参数	是否必选	参数类型	描述
key	否	String	云服务器标签的键。不得以"CCE-"或"__type_baremetal"开头
value	否	String	云服务器标签的值

**表25** Runtime
参数	是否必选	参数类型	描述
name	否	String	容器运行时, 默认场景： 1.25以下集群：默认为"docker" 1.25及以上集群，随操作系统变化，默认的容器运行时不同：操作系统为欧拉2.5、欧拉2.8的节点默认为"docker"，其余操作系统的节点默认为"containerd"

**表26** NodeExtendParam
参数	是否必选	参数类型	描述
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	安装前执行脚本说明：输入的值需要经过Base64编码，方法为echo -n "待编码内容" \| base64
alpha.cce/postInstall	否	String	安装后执行脚本说明：输入的值需要经过Base64编码，方法为echo -n "待编码内容" \| base64。
alpha.cce/NodeImageID	否	String	如果创建裸金属节点，需要使用自定义镜像时用此参数。
enterprise_project_id	否	String	节点所属的企业项目id。
chargingMode	否	Integer	节点的计费模式。已废弃，请使用NodeSpec中的billingMode字段。
agency_name	否	String	委托的名称。委托是由租户管理员在统一身份认证服务（Identity and Access Management，IAM）上创建的，可以为CCE节点提供访问云服务器的临时凭证。作为响应参数仅在创建节点传入时返回该字段。

响应参数

状态码： 201

**表27** 响应Body参数
参数	参数类型	描述
kind	String	API类型，固定值“Node”，该值不可修改。
apiVersion	String	API版本，固定值“v3”，该值不可修改。
metadata	NodeMetadata object	metadata是节点对象的元数据定义，是集合类的元素类型，包含一组由不同名称定义的属性。
spec	NodeSpec object	spec是集合类的元素类型，用户对需要管理的节点对象进行详细描述的主体部分都在spec中给出。系统通过spec的描述来创建或更新对象。
status	NodeStatus object	节点状态，动态记录，创建或修改时指定无意义.

**表28** NodeMetadata
参数	参数类型	描述
name	String	节点名称说明：命名规则：以小写字母开头，由小写字母、数字、中划线(-)组成，长度范围1-56位，且不能以中划线(-)结尾。若name未指定或指定为空字符串，则按照默认规则生成节点名称。默认规则为：“集群名称-随机字符串”，若集群名称过长，则只取前36个字符。若节点数量(count)大于1时，则按照默认规则会在用户输入的节点名称末尾添加随机字符串。默认规则为：“用户输入名称-随机字符串”，若用户输入的节点名称长度范围超过50位时，系统截取前50位，并在末尾添加随机字符串。
uid	String	节点ID，资源唯一标识，创建成功后自动生成，填写无效
labels	Map<String,String>	CCE自有节点标签，非Kubernetes原生labels。标签可用于选择对象并查找满足某些条件的对象集合，格式为key/value键值对。示例： "labels": { "key" : "value" }
annotations	Map<String,String>	CCE自有节点注解，非Kubernetes原生annotations，格式为key/value键值对。示例： "annotations": { "key1" : "value1", "key2" : "value2" } 说明： Annotations不用于标识和选择对象。Annotations中的元数据可以是small或large，structured或unstructured，并且可以包括标签不允许使用的字符。仅用于查询，不支持请求时传入，填写无效。
creationTimestamp	String	创建时间，创建成功后自动生成，填写无效
updateTimestamp	String	更新时间，创建成功后自动生成，填写无效

**表29** NodeSpec
参数	参数类型	描述
flavor	String	节点的规格，CCE支持的节点规格请参考节点规格说明获取。
az	String	待创建节点所在的可用区，需要指定可用区（AZ）的名称。
os	String	节点的操作系统类型。具体支持的操作系统请参见节点操作系统说明。说明：系统会根据集群版本自动选择支持的系统版本。当前集群版本不支持该系统类型，则会报错。若在创建节点时指定了extendParam中的alpha.cce/NodeImageID参数，可以不填写此参数。
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个。字段使用场景：在节点创建场景下，支持指定初始值，查询时不返回该字段；在节点池场景下，其中节点模板中支持指定初始值，查询时支持返回该字段；在其余场景下，查询时都不会返回该字段。说明：标签键只能包含大写字母.小写字母、数字和特殊字符(-_)以及Unicode字符，长度不超过36个字符。
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调度到节点上。 cce支持自定义初始化标记，在接收到initializedConditions参数后，会将参数值转换成节点标签，随节点下发，例如：cloudprovider.openvessel.io/inject-initialized-conditions=CCEInitial_CustomedInitial。当节点上设置了此标签，会轮询节点的status.Conditions，查看conditions的type是否存在标记名，如CCEInitial、CustomedInitial标记，如果存在所有传入的标记，且状态为True，认为节点初始化完成，则移除初始化污点。必须以字母、数字组成，长度范围1-20位。标记数量不超过2个
extendParam	NodeExtendParam object	创建节点时的扩展参数。

**表30** Login
参数	参数类型	描述
sshKey	String	选择密钥对方式登录时的密钥对名称。

**表31** UserPassword
参数	参数类型	描述
username	String	登录帐号，默认为“root”
password	String	登录密码，若创建节点通过用户名密码方式，即使用该字段，则响应体中该字段作屏蔽展示。密码复杂度要求：长度为8-26位。密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?~#*）中的三种。密码不能包含用户名或用户名的逆序。创建节点时password字段需要加盐加密，具体方法请参见创建节点时password字段加盐加密。

**表32** Volume
参数	参数类型	描述
size	Integer	磁盘大小，单位为GB 系统盘取值范围：40~1024
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	云硬盘加密信息，仅在创建节点系统盘或数据盘需加密时须填写。

**表33** VolumeMetadata
参数	参数类型	描述
__system__encrypted	String	表示云硬盘加密功能的字段，'0'代表不加密，'1'代表加密。该字段不存在时，云硬盘默认为不加密。
__system__cmkid	String	用户主密钥ID，是metadata中的表示加密功能的字段，与__system__encrypted配合使用。

**表34** Storage
参数	参数类型	描述
storageSelectors	Array of StorageSelectors objects	磁盘选择，根据matchLabels和storageType对匹配的磁盘进行管理。磁盘匹配存在先后顺序，靠前的匹配规则优先匹配。
storageGroups	Array of StorageGroups objects	由多个存储设备组成的存储组，用于各个存储空间的划分。

**表35** 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五个字段。

**表36** matchLabels
参数	参数类型	描述
size	String	匹配的磁盘大小，不填则无磁盘大小限制。例如：100.
volumeType	String	云硬盘类型，目前支持SSD\GPSSD\SAS三种。
metadataEncrypted	String	磁盘加密标识符，0代表不加密，1代表加密。
metadataCmkid	String	加密磁盘的用户主密钥ID，长度为36字节的字符串。
count	String	磁盘选择个数，不填则选择所有此类磁盘。

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

**表38** 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配置。

**表39** LVMConfig
参数	参数类型	描述
lvType	String	LVM写入模式：linear、striped。linear：线性模式；striped：条带模式，使用多块磁盘组成条带模式，能够提升磁盘性能。
path	String	磁盘挂载路径。仅在用户配置中生效。支持包含：数字、大小写字母、点、中划线、下划线的绝对路径。

**表40** RuntimeConfig
参数	参数类型	描述
lvType	String	LVM写入模式：linear、striped。linear：线性模式；striped：条带模式，使用多块磁盘组成条带模式，能够提升磁盘性能。

**表41** NodePublicIP
参数	参数类型	描述
ids	Array of strings	已有的弹性IP的ID列表。数量不得大于待创建节点数说明：若已配置ids参数，则无需配置count和eip参数
count	Integer	要动态创建的弹性IP个数。说明： count参数与eip参数必须同时配置。
eip	NodeEIPSpec object	弹性IP参数

**表42** NodeEIPSpec
参数	参数类型	描述
iptype	String	弹性IP类型，取值请参见申请EIP接口中publicip.type说明。
bandwidth	NodeBandwidth object	弹性IP的带宽参数

**表43** NodeBandwidth
参数	参数类型	描述
chargemode	String	带宽的计费类型：未传该字段，表示按带宽计费。 - 字段值为空，表示按带宽计费。字段值为“traffic”，表示按流量计费。字段为其它值，会导致创建云服务器失败。说明：按带宽计费：按公网传输速率（单位为Mbps）计费。当您的带宽利用率高于10%时，建议优先选择按带宽计费。按流量计费：只允许在创建按需节点时指定，按公网传输的数据总量（单位为GB）计费。当您的带宽利用率低于10%时，建议优先选择按流量计费。
size	Integer	带宽大小，取值请参见取值请参见申请EIP接口中bandwidth.size说明。
sharetype	String	带宽的共享类型，共享类型枚举：PER，表示独享，目前仅支持独享。

**表44** NodeNicSpec
参数	参数类型	描述
primaryNic	NicSpec object	主网卡的描述信息。
extNics	Array of NicSpec objects	扩展网卡说明：创建节点池添加节点时不支持该参数。

**表45** NicSpec
参数	参数类型	描述
subnetId	String	网卡所在子网的网络ID。主网卡创建时若未指定subnetId,将使用集群子网。扩展网卡创建时必须指定subnetId。
fixedIps	Array of strings	主网卡的IP将通过fixedIps指定，数量不得大于创建的节点数。fixedIps或ipBlock同时只能指定一个。扩展网卡不支持指定fiexdIps。
ipBlock	String	主网卡的IP段的CIDR格式，创建的节点IP将属于该IP段内。fixedIps或ipBlock同时只能指定一个。

**表46** Taint
参数	参数类型	描述
key	String	键
value	String	值
effect	String	作用效果

**表47** UserTag
参数	参数类型	描述
key	String	云服务器标签的键。不得以"CCE-"或"__type_baremetal"开头
value	String	云服务器标签的值

**表48** Runtime
参数	参数类型	描述
name	String	容器运行时, 默认场景： 1.25以下集群：默认为"docker" 1.25及以上集群，随操作系统变化，默认的容器运行时不同：操作系统为欧拉2.5、欧拉2.8的节点默认为"docker"，其余操作系统的节点默认为"containerd"

**表49** NodeExtendParam
参数	参数类型	描述
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	安装前执行脚本说明：输入的值需要经过Base64编码，方法为echo -n "待编码内容" \| base64
alpha.cce/postInstall	String	安装后执行脚本说明：输入的值需要经过Base64编码，方法为echo -n "待编码内容" \| base64。
alpha.cce/NodeImageID	String	如果创建裸金属节点，需要使用自定义镜像时用此参数。
enterprise_project_id	String	节点所属的企业项目id。
chargingMode	Integer	节点的计费模式。已废弃，请使用NodeSpec中的billingMode字段。
agency_name	String	委托的名称。委托是由租户管理员在统一身份认证服务（Identity and Access Management，IAM）上创建的，可以为CCE节点提供访问云服务器的临时凭证。作为响应参数仅在创建节点传入时返回该字段。

**表50** NodeStatus
参数	参数类型	描述
phase	String	节点状态：节点资源生命周期管理（如安装卸载等）状态和集群内k8s node状态的综合体现。
lastProbeTime	String	节点最近一次状态检查时间。集群处于异常、冻结或者中间态（例如创建中）时，节点的状态检查动作可能受影响。检查时间超过5分的节点状态不具有参考意义。
jobID	String	创建或删除时的任务ID。
serverId	String	底层云服务器或裸金属节点ID。
privateIP	String	节点主网卡私有网段IP地址。
privateIPv6IP	String	节点主网卡私有网段IPv6地址。
publicIP	String	节点弹性公网IP地址。如果ECS的数据没有实时同步，可在界面上通过“同步节点信息”手动进行更新。
deleteStatus	DeleteStatus object	删除资源时表示资源删除状态

**表51** DeleteStatus
参数	参数类型	描述
previous_total	Integer	集群删除时已经存在的集群资源记录总数
current_total	Integer	基于当前集群资源记录信息，生成实际最新资源记录总数
updated	Integer	集群删除时更新的资源记录总数
added	Integer	集群删除时更新的资源记录总数
deleted	Integer	集群删除时删除的资源记录总数

请求示例

创建按需节点

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes

{
  "kind" : "Node",
  "apiVersion" : "v3",
  "metadata" : {
    "name" : "test-83790"
  },
  "spec" : {
    "flavor" : "c7.large.2",
    "az" : "******",
    "os" : "EulerOS 2.5",
    "dataVolumes" : [ {
      "size" : 100,
      "volumetype" : "SAS"
    } ],
    "billingMode" : 0,
    "extendParam" : {
      "maxPods" : 110
    },
    "nodeNicSpec" : {
      "primaryNic" : {
        "subnetId" : "ca964acf-8468-4735-8229-97940ef6c881"
      }
    },
    "rootVolume" : {
      "size" : 50,
      "volumetype" : "SAS"
    },
    "runtime" : {
      "name" : "docker"
    },
    "login" : {
      "sshKey" : "KeyPair-001"
    },
    "storage" : {
      "storageSelectors" : [ {
        "name" : "cceUse",
        "storageType" : "evs",
        "matchLabels" : {
          "size" : "100",
          "volumeType" : "SAS",
          "count" : "1"
        }
      } ],
      "storageGroups" : [ {
        "name" : "vgpaas",
        "selectorNames" : [ "cceUse" ],
        "cceManaged" : true,
        "virtualSpaces" : [ {
          "name" : "runtime",
          "size" : "90%"
        }, {
          "name" : "kubernetes",
          "size" : "10%"
        } ]
      } ]
    },
    "count" : 1
  }
}

响应示例

状态码： 201

表示在指定集群下创建节点的作业下发成功。

{
  "kind" : "Node",
  "apiVersion" : "v3",
  "metadata" : {
    "name" : "test-83790",
    "uid" : "5ecfddfe-87db-11ec-b5e5-0255ac101514",
    "annotations" : {
      "jobid" : "5ec1518c-87db-11ec-b5e5-0255ac101514",
      "resourceJobId" : "5ed0d692-87db-11ec-b5e5-0255ac101514"
    }
  },
  "spec" : {
    "flavor" : "c7.large.2",
    "az" : "******",
    "os" : "EulerOS 2.5",
    "login" : {
      "sshKey" : "KeyPair-001"
    },
    "rootVolume" : {
      "volumetype" : "SAS",
      "size" : 50
    },
    "dataVolumes" : [ {
      "volumetype" : "SAS",
      "size" : 100
    } ],
    "storage" : {
      "storageSelectors" : [ {
        "name" : "cceUse",
        "storageType" : "evs",
        "matchLabels" : {
          "count" : "1",
          "size" : "100",
          "volumeType" : "SAS"
        }
      } ],
      "storageGroups" : [ {
        "name" : "vgpaas",
        "cceManaged" : true,
        "selectorNames" : [ "cceUse" ],
        "virtualSpaces" : [ {
          "name" : "runtime",
          "size" : "90%"
        }, {
          "name" : "kubernetes",
          "size" : "10%"
        } ]
      } ]
    },
    "publicIP" : {
      "eip" : {
        "bandwidth" : { }
      }
    },
    "nodeNicSpec" : {
      "primaryNic" : {
        "subnetId" : "ca964acf-8468-4735-8229-97940ef6c881"
      }
    },
    "count" : 1,
    "billingMode" : 0,
    "runtime" : {
      "name" : "docker"
    },
    "extendParam" : {
      "chargingMode" : 0,
      "ecs:performancetype" : "computingv3",
      "enterprise_project_id" : "0",
      "init-node-password" : "******",
      "maxPods" : 110,
      "publicKey" : ""
    }
  },
  "status" : {
    "jobID" : "5ec1518c-87db-11ec-b5e5-0255ac101514"
  }
}

状态码

状态码	描述
201	表示在指定集群下创建节点的作业下发成功。

错误码

请参见错误码。

父主题： 节点管理

上一篇：节点管理

下一篇：获取指定的节点

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消