更新时间:2026-09-30 GMT+08:00

获取集群下所有节点

功能介绍

该API用于通过集群ID获取指定集群下所有节点的详细信息。

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

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

cluster_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

设置每页显示的数据条数。

约束限制:

不涉及

取值范围:

1到2000之间(含1和2000)的整数。

默认取值:

2000

marker

否

String

参数解释:

通过资源uid进行分页查询,默认为查询第一页数据。marker={{uid}}表示查询该uid后的资源列表的信息(查询结果不包含该uid的资源)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

无

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释:

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

约束限制:

GET方法不做校验

取值范围:

不涉及

默认取值:

不涉及

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

kind

String

参数解释:

API类型

取值范围:

不涉及

apiVersion

String

参数解释:

API版本

取值范围:

不涉及

items

Array of Node objects

参数解释:

节点对象列表,包含了当前集群下所有节点的详细信息。可通过items.metadata.name下的值来找到对应的节点。

取值范围:

不涉及

pageInfo

NodePageInfo object

参数解释:

分页信息。

取值范围:

不涉及

表5 Node

参数

参数类型

描述

kind

String

参数解释:

API类型

取值范围:

不涉及

apiVersion

String

参数解释:

API版本

取值范围:

不涉及

metadata

NodeMetadata object

参数解释:

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

spec

NodeSpec object

参数解释:

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

status

NodeStatus object

参数解释:

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

表6 NodeMetadata

参数

参数类型

描述

name

String

参数解释:

节点名称

取值范围:

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

uid

String

参数解释:

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

取值范围:

不涉及

annotations

Map<String,String>

参数解释:

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

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

取值范围:

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

creationTimestamp

String

参数解释:

创建时间

取值范围:

不涉及

updateTimestamp

String

参数解释:

更新时间

取值范围:

不涉及

ownerReferences

ownerReferences object

参数解释:

属主对象。

取值范围:

不涉及

表7 ownerReferences

参数

参数类型

描述

nodepoolName

String

参数解释:

节点池名称

取值范围:

不涉及

nodepoolID

String

参数解释:

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

取值范围:

不涉及

hyperNodeName

String

参数解释:

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

取值范围:

不涉及

hyperNodeID

String

参数解释:

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

取值范围:

不涉及

表8 NodeSpec

参数

参数类型

描述

flavor

String

参数解释:

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

取值范围:

不涉及

az

String

参数解释:

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

取值范围:

不涉及

os

String

参数解释:

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

取值范围:

不涉及

login

Login object

参数解释:

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

rootVolume

Volume object

参数解释:

节点的磁盘信息。

dataVolumes

Array of Volume objects

参数解释:

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

storage

Storage object

参数解释:

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

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

取值范围:

不涉及

publicIP

NodePublicIP object

参数解释:

节点的弹性公网IP。

nodeNicSpec

NodeNicSpec object

参数解释:

节点的网卡信息。

count

Integer

参数解释:

批量创建时节点的个数。

取值范围:

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

billingMode

Integer

参数解释:

节点的计费模式。

取值范围:

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

waitPostInstallFinish

Boolean

参数解释:

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

取值范围:

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

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

k8sTags

Map<String,String>

参数解释:

格式为key/value键值对。

  • 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

参数解释:

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

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'

extendParam

NodeExtendParam object

参数解释:

创建节点时的扩展参数。

hostnameConfig

HostnameConfig object

参数解释:

K8S节点名称配置参数。

serverEnterpriseProjectID

String

参数解释:

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

取值范围:

不涉及

nodeNameTemplate

nodeNameTemplate object

参数解释:

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

取值范围:

不涉及

表9 Login

参数

参数类型

描述

sshKey

String

参数解释:

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

取值范围:

不涉及

userPassword

UserPassword object

参数解释:

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

取值范围:

不涉及

removeUserPassword

Boolean

参数解释:

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

取值范围:

不涉及

removeSSHKey

Boolean

参数解释:

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

取值范围:

不涉及

表10 UserPassword

参数

参数类型

描述

username

String

参数解释:

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

取值范围:

不涉及

password

String

参数解释:

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

取值范围:

密码复杂度要求:

  • 长度为8-26位。

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

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

表11 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

参数解释:

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

取值范围:

不涉及

表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的索引。

取值范围:

不涉及

storageType

String

参数解释:

存储类型。

取值范围:

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

matchLabels

matchLabels object

参数解释:

evs盘的匹配字段。

取值范围:

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

表15 matchLabels

参数

参数类型

描述

size

String

参数解释:

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

取值范围:

不涉及

volumeType

String

参数解释:

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

取值范围:

不涉及

metadataEncrypted

String

参数解释:

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

取值范围:

不涉及

metadataCmkid

String

参数解释:

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

取值范围:

不涉及

count

String

参数解释:

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

取值范围:

不涉及

表16 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选择。

取值范围:

不涉及

virtualSpaces

Array of VirtualSpace objects

参数解释:

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

取值范围:

不涉及

表17 VirtualSpace

参数

参数类型

描述

name

String

参数解释:

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

取值范围:

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

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

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

size

String

参数解释:

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

取值范围:

1% ~ 100%

lvmConfig

LVMConfig object

参数解释:

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

取值范围:

不涉及

runtimeConfig

RuntimeConfig object

参数解释:

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

取值范围:

不涉及

表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列表。

count

Integer

参数解释:

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

取值范围:

不涉及

eip

NodeEIPSpec object

参数解释:

弹性IP参数。

iptype

String

参数解释:

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

取值范围:

不涉及

bandwidth

NodeBandwidth object

参数解释:

弹性IP的带宽参数

表21 NodeEIPSpec

参数

参数类型

描述

iptype

String

参数解释:

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

取值范围:

不涉及

bandwidth

NodeBandwidth object

参数解释:

弹性IP的带宽参数。

表22 NodeBandwidth

参数

参数类型

描述

chargemode

String

参数解释:

带宽的计费类型。

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

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

取值范围:

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

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

  • 字段值为“bandwidth”,表示按带宽计费。

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

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

size

Integer

参数解释:

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

取值范围:

不涉及

sharetype

String

参数解释:

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

取值范围:

不涉及

表23 NodeNicSpec

参数

参数类型

描述

primaryNic

NicSpec object

参数解释:

主网卡的描述信息。

extNics

Array of NicSpec objects

参数解释:

扩展网卡。

表24 NicSpec

参数

参数类型

描述

subnetId

String

参数解释:

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

取值范围:

不涉及

fixedIps

Array of strings

参数解释:

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

ipBlock

String

参数解释:

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

取值范围:

不涉及

subnetList

Array of strings

参数解释:

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

表25 Taint

参数

参数类型

描述

key

String

参数解释:

K8s污点的键。

取值范围:

不涉及

value

String

参数解释:

K8s污点的值。

取值范围:

不涉及

effect

String

参数解释:

K8s污点的作用效果。

取值范围:

只可选NoSchedule,PreferNoSchedule或NoExecute。

表26 UserTag

参数

参数类型

描述

key

String

参数解释:

云服务器标签的键。

取值范围:

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

value

String

参数解释:

云服务器标签的值。

取值范围:

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

表27 Runtime

参数

参数类型

描述

name

String

参数解释:

容器运行时。

取值范围:

不涉及

runtimeClass

String

参数解释:

容器运行时子类别。

取值范围:

  • 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或以上版本。

表28 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节点容器运行时空间配置请参考数据盘空间分配说明。

取值范围:

10-500。

containerBaseSize

Integer

参数解释:

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

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

取值范围:

10-500。

publicKey

String

参数解释:

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

取值范围:

不涉及

alpha.cce/preInstall

String

参数解释:

安装前执行脚本。

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

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

取值范围:

不涉及

alpha.cce/postInstall

String

参数解释:

安装后执行脚本。

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

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

取值范围:

不涉及

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。

取值范围:

不涉及

systemReservedCpu

Integer

参数解释:

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

取值范围:

不涉及

kubeReservedPid

Integer

参数解释:

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

取值范围:

[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。

取值范围:

[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。

取值范围:

不涉及

systemReservedStorage

Integer

参数解释:

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

取值范围:

不涉及

init-node-password

String

参数解释:

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

取值范围:

不涉及

表29 HostnameConfig

参数

参数类型

描述

type

String

参数解释:

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

取值范围:

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

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

表30 nodeNameTemplate

参数

参数类型

描述

nodeNamePrefix

String

参数解释:

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

取值范围:

不涉及

nodeNameSuffix

String

参数解释:

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

取值范围:

不涉及

表31 NodeStatus

参数

参数类型

描述

phase

String

参数解释:

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

取值范围:

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

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

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

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

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

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

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

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

  • Repairing: 修复中,表示节点处于修复过程中。仅在节点所在节点池开启节点重启自愈策略时产生,基础自愈策略不产生此状态。

  • RepairFailed:修复失败,表示节点处于修复失败状态。仅在节点所在节点池开启节点重启自愈策略时产生,基础自愈策略不产生此状态。

lastProbeTime

String

参数解释:

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

取值范围:

不涉及

jobID

String

参数解释:

创建或删除时的任务ID。

取值范围:

不涉及

serverId

String

参数解释:

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

若该节点为超节点的子节点,则为超节点子节点的底层实例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。

取值范围:

不涉及

表32 DeleteStatus

参数

参数类型

描述

previous_total

Integer

参数解释:

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

取值范围:

不涉及

current_total

Integer

参数解释:

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

取值范围:

不涉及

updated

Integer

参数解释:

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

取值范围:

不涉及

added

Integer

参数解释:

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

取值范围:

不涉及

deleted

Integer

参数解释:

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

取值范围:

不涉及

表33 NodePageInfo

参数

参数类型

描述

currentCount

Integer

参数解释:

当前页返回的所有节点数。

取值范围:

不涉及

nextMarker

String

参数解释:

当前页最后一条记录,为查询下一页的marker取值,最后一页时无nextMarker字段。

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

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

{
  "kind" : "List",
  "apiVersion" : "v3",
  "items" : [ {
    "kind" : "Node",
    "apiVersion" : "v3",
    "metadata" : {
      "name" : "myhost",
      "uid" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
      "creationTimestamp" : "2018-08-02 07:37:24.005071325 +0000 UTC",
      "updateTimestamp" : "2018-08-02 07:44:04.965500815 +0000 UTC",
      "annotations" : {
        "kubernetes.io/node-pool.id" : "az1.dc1#s1.medium#EulerOS 2.2"
      }
    },
    "spec" : {
      "flavor" : "s1.medium",
      "az" : "az1.dc1",
      "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" : "100.85.122.144",
      "privateIP" : "192.168.1.23"
    }
  } ],
  "pageInfo" : {
    "currentCount" : 1
  }
}

状态码

状态码

描述

200

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

错误码

请参见错误码。