查询集群中超节点列表 - ListHyperNodes

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

账号的项目ID

默认取值：

不涉及

cluster_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

集群ID

默认取值：

不涉及

limit

否

Integer

参数解释：

设置每页显示的数据条数

约束限制：

不涉及

取值范围：

1到1000之间（含1和1000）的整数

默认取值：

100

offset

否

Integer

参数解释：

设置从第几条数据开始显示（用于翻页），比如输入0表示从第一条数据开始，输入10表示跳过前10条，从第11条开始显示，不填时默认从第一条开始显示（即默认为0）。

约束限制：

不涉及

取值范围：

32 位非负整数

默认取值：

0

[数组元素]

Array of HyperNode objects

参数解释：

超节点

取值范围：

不涉及

apiVersion

String

参数解释：

API版本，固定值v3。

取值范围：

• v3

kind

String

参数解释：

API类型，固定值HyperNode。

取值范围：

• HyperNode

metadata

HyperNodeMetadata object

参数解释：

超节点元数据

取值范围：

不涉及

spec

HyperNodeSpec object

参数解释：

超节点信息

取值范围：

不涉及

status

HyperNodeStatus object

参数解释：

超节点状态

取值范围：

不涉及

name

String

参数解释：

超节点名称。

取值范围：

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

uid

String

参数解释：

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

取值范围：

UUID格式

creationTimestamp

String

参数解释：

创建时间，创建成功后自动生成，填写无效

取值范围：

不涉及

updateTimestamp

String

参数解释：

更新时间，系统自动生成，填写无效。

取值范围：

不涉及

ownerReference

ownerReference object

参数解释：

属主对象

取值范围：

不涉及

nodepoolName

String

参数解释：

节点池名称

取值范围：

不涉及

nodepoolID

String

参数解释：

节点池ID

取值范围：

不涉及

flavor

String

参数解释：

超节点规格

取值范围：

不涉及

nodepoolID

String

参数解释：

所属节点池ID

取值范围：

不涉及

nodeTemplate

Array of NodeTemplateInHyperNode objects

参数解释：

超节点下节点相关的配置。

取值范围：

不涉及

chargeMode

String

参数解释：

付费方式

取值范围：

• prepaid：预付费，即包年包月；

• postpaid：后付费，即按需付费；

az

String

参数解释：

超节点下节点所在的可用区。

CCE支持的可用区请参考地区和终端节点。

取值范围：

不涉及

os

String

参数解释：

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

取值范围：

不涉及

login

Login object

参数解释：

节点的登录方式。

取值范围：

不涉及

rootVolume

Volume object

参数解释：

节点的系统卷信息。

取值范围：

不涉及

dataVolumes

Array of Volume objects

参数解释：

节点的数据盘参数。

取值范围：

不涉及

storage

Storage object

参数解释：

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

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

取值范围：

不涉及

k8sTags

Map<String,String>

参数解释：

超节点创建时下发到节点上的 k8s 标签，格式为key/value键值对。

示例：

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

取值范围：

不涉及

runtime

Runtime object

参数解释：

容器运行时

取值范围：

不涉及

extendParam

NodeExtendParam object

参数解释：

创建节点时的扩展参数。

取值范围：

不涉及

hostnameConfig

HostnameConfig object

参数解释：

K8S节点名称配置参数。

取值范围：

不涉及

sshKey

String

参数解释：

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

取值范围：

不涉及

userPassword

UserPassword object

参数解释：

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

取值范围：

不涉及

removeUserPassword

Boolean

参数解释：

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

取值范围：

不涉及

removeSSHKey

Boolean

参数解释：

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

取值范围：

不涉及

username

String

参数解释：

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

取值范围：

不涉及

password

String

参数解释：

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

取值范围：

密码复杂度要求：

• 长度为8-26位。

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

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

size

Integer

参数解释：

磁盘大小，单位为GiB。

取值范围：

• 系统盘取值范围：40~1024

• 第一块数据盘取值范围：20~32768(当缺省磁盘初始化配置管理参数storage时，数据盘取值范围：100-32768)

• 其他数据盘取值范围：10~32768(当缺省磁盘初始化配置管理参数storage时，数据盘取值范围：100-32768)

volumetype

String

参数解释：

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

取值范围：

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

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

• SATA：普通IO，是指由SATA存储提供资源的磁盘类型。EVS已下线SATA磁盘，仅存量节点有此类型的磁盘。

• ESSD：极速型SSD云硬盘，是指由极速型SSD存储提供资源的磁盘类型。

• GPSSD：通用型SSD云硬盘，是指由通用型SSD存储提供资源的磁盘类型。

• ESSD2：极速型SSD V2云硬盘，是指由极速型SSD V2存储提供资源的磁盘类型。

• GPSSD2：通用型SSD V2云硬盘，是指由通用型SSD V2存储提供资源的磁盘类型。

iops

Integer

参数解释：

给云硬盘配置iops。

取值范围：

了解GPSSD2、ESSD2类型的iops大小范围，请参见云硬盘类型及性能介绍里面的云硬盘性能数据表。

throughput

Integer

参数解释：

给云硬盘配置吞吐量，单位是MiB/s。

取值范围：

了解GPSSD2类型的吞吐量大小范围，请参见云硬盘类型及性能介绍里面的云硬盘性能数据表。

extendParam

Map<String,Object>

参数解释：

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

链接请参见创建磁盘的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配合使用。

取值范围：

不涉及

storageSelectors

Array of StorageSelectors objects

参数解释：

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

取值范围：

不涉及

storageGroups

Array of StorageGroups objects

参数解释：

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

取值范围：

不涉及

name

String

参数解释：

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

取值范围：

不涉及

storageType

String

参数解释：

存储类型。

取值范围：

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

matchLabels

matchLabels object

参数解释：

evs盘的匹配字段。

取值范围：

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

size

String

参数解释：

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

取值范围：

不涉及

volumeType

String

参数解释：

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

取值范围：

不涉及

iops

String

参数解释：

匹配的磁盘iops大小，不填则无磁盘iops大小限制。当需要选择GPSSD2或ESSD2类型磁盘时，配置iops来准确选择磁盘。例如：3000。

取值范围：

不涉及

throughput

String

参数解释：

匹配的磁盘吞吐量大小，不填则无磁盘吞吐量大小限制。当需要选择GPSSD2类型磁盘时，配置throughput来准确选择磁盘。例如：125。

取值范围：

不涉及

metadataEncrypted

String

参数解释：

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

取值范围：

不涉及

metadataCmkid

String

参数解释：

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

取值范围：

不涉及

count

String

参数解释：

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

取值范围：

不涉及

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

取值范围：

不涉及

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空间配置。

取值范围：

不涉及

runtimeConfig

RuntimeConfig object

参数解释：

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

取值范围：

不涉及

lvType

String

参数解释：

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

取值范围：

不涉及

path

String

参数解释：

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

取值范围：

不涉及

lvType

String

参数解释：

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

取值范围：

不涉及

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

ecs:performancetype

String

参数解释：

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

取值范围：

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

链接请参见查询规格详情和规格扩展信息列表

orderID

String

参数解释：

订单ID。

取值范围：

不涉及

productID

String

参数解释：

产品ID。

取值范围：

不涉及

maxPods

Integer

参数解释：

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

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

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

取值范围：

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

periodType

String

参数解释：

订购周期类型。

取值范围：

• month：月

• year：年

periodNum

Integer

参数解释：

订购周期数。

取值范围：

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

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

isAutoRenew

String

参数解释：

是否自动续订。

取值范围：

• “true”：自动续订

• “false”：不自动续订

isAutoPay

String

参数解释：

下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付。

取值范围：

• “true”：是（自动扣款）

• “false”：否（不自动扣款）

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

参数解释：

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

取值范围：

不涉及

securityReinforcementType

String

参数解释：

指定节点安全加固类型，当前仅支持HCE2.0镜像等保2.0三级安全加固。 等保加固会对身份鉴别、访问控制、安全审计、入侵防范、恶意代码防范进行检查并加固。详情请参见Huawei Cloud EulerOS 2.0等保2.0三级版镜像概述。

若未指定此参数，则尝试用原有的值补全。如：原先HCE2.0镜像已配置安全加固，更新节点池时未指定此参数，则仍旧保持安全加固配置，若要取消，需显式指定参数值为"null"。

取值范围：

• 空值：表示不开启等保加固

• cybersecurity：表示开启等保加固

serverMetadataHttpTokens

String

参数解释：

是否要求携带token，默认optional。

取值范围：

• optional：不要求携带token。

• required：要求必须携带token，即IMDS服务禁用v1版本，启用v2版本。

type

String

参数解释：

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

取值范围：

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

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

phase

String

参数解释：

超节点状态

取值范围：

• provisioning：创建中。

• active：整体可用，代表超节点下所有节点都可用。

• partially-available：超节点下存在不可用节点时会从 active 转成此状态。

• error：错误状态。

• deleting：删除中。

• reinstalling：重置中。

• scaling：扩容或缩容中。

instanceID

String

参数解释：

超节点ID

取值范围：

不涉及

currentNode

Integer

参数解释：

超节点下节点总数

取值范围：

大于等于0的整数

deletingNode

Integer

参数解释：

超节点下处于删除中的节点数

取值范围：

大于等于0的整数

creatingNode

Integer

参数解释：

超节点下处于创建中的节点数

取值范围：

大于等于0的整数

activeNode

Integer

参数解释：

超节点下处于可用状态的节点数

取值范围：

大于等于0的整数

200

查询集群中超节点列表