该API用于通过节点ID获取指定节点的详细信息。
集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径。
名称 | 类型 | IN | 必选 | 描述 |
---|---|---|---|---|
Content-Type
|
string | header | 是 |
消息体的类型(格式) |
X-Auth-Token
|
string | header | 是 |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 |
project_id
|
string | path | 是 |
项目ID,获取方式请参见如何获取接口URI中参数。 |
cluster_id
|
string | path | 是 |
集群ID,获取方式请参见如何获取接口URI中参数。 |
node_id
|
string | path | 是 |
节点ID,获取方式请参见如何获取接口URI中参数。 |
表示获取集群下指定的节点成功。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
kind
|
string | 否 |
API类型,固定值“Node”,该值不可修改。 |
apiVersion
|
string | 否 |
API版本,固定值“v3”,该值不可修改。 |
metadata
|
NodeMetadata object | 否 |
metadata是节点对象的元数据定义,是集合类的元素类型,包含一组由不同名称定义的属性。 |
spec
|
NodeSpec object | 否 |
spec是集合类的元素类型,用户对需要管理的节点对象进行详细描述的主体部分都在spec中给出。系统通过spec的描述来创建或更新对象。 |
status
|
NodeStatus object | 否 |
节点状态,动态记录,创建或修改时指定无意义. |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
name
|
string | 否 |
节点名称
|
uid
|
string | 否 |
节点ID,资源唯一标识,创建成功后自动生成,填写无效 |
labels
|
Map<String,String> | 否 |
CCE自有节点标签,非Kubernetes原生labels。 标签可用于选择对象并查找满足某些条件的对象集合,格式为key/value键值对。 示例:
|
annotations
|
Map<String,String> | 否 |
CCE自有节点注解,非Kubernetes原生annotations,格式为key/value键值对。 示例:
|
creationTimestamp
|
string | 否 |
创建时间,创建成功后自动生成,填写无效 |
updateTimestamp
|
string | 否 |
更新时间,创建成功后自动生成,填写无效 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
flavor
|
string | 是 |
节点的规格,CCE支持的节点规格请参考节点规格说明获取。 |
az
|
string | 是 | |
os
|
string | 否 |
节点的操作系统类型。具体支持的操作系统请参见节点操作系统说明。
|
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 | 否 |
节点的计费模式:
|
taints
|
Array of Taint objects | 否 |
支持给创建出来的节点加Taints来设置反亲和性,taints配置不超过20条。每条Taints包含以下3个参数:
示例:
|
k8sTags
|
Map<String,String> | 否 |
格式为key/value键值对。键值对个数不超过20条。
示例:
|
ecsGroupId
|
string | 否 | |
dedicatedHostId
|
string | 否 |
指定DeH主机的ID,将节点调度到自己的DeH上。
|
userTags
|
Array of UserTag objects | 否 |
云服务器标签,键必须唯一,CCE支持的最大用户自定义标签数量依region而定,自定义标签数上限为8个。 字段使用场景:在节点创建场景下,支持指定初始值,查询时不返回该字段;在节点池场景下,其中节点模板中支持指定初始值,查询时支持返回该字段;在其余场景下,查询时都不会返回该字段。 |
runtime
|
Runtime object | 否 |
容器运行时, 默认场景:
|
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,认为节点初始化完成,则移除初始化污点。
|
extendParam
|
NodeExtendParam object | 否 |
创建节点时的扩展参数。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
sshKey
|
string | 否 |
选择密钥对方式登录时的密钥对名称。 |
userPassword
|
UserPassword object | 否 |
选择密码方式登录时的帐号密码信息,之后可通过此帐号密码登录节点。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
username
|
string | 否 |
登录帐号,默认为“root” |
password
|
string | 是 |
登录密码,若创建节点通过用户名密码方式,即使用该字段,则响应体中该字段作屏蔽展示。 密码复杂度要求:
|
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
size
|
integer | 是 |
磁盘大小,单位为GB
|
volumetype
|
string | 是 |
磁盘类型,取值请参见创建云服务器 中“root_volume字段数据结构说明”。
|
extendParam
|
Map<String,Object> | 否 |
磁盘扩展参数,取值请参见创建云服务器中“extendparam”参数的描述。 链接请参见创建云服务器 |
cluster_id
|
string | 否 |
云服务器系统盘对应的存储池的ID。仅用作专属云集群, 专属分布式存储 DSS的存储池ID,即dssPoolID。 获取方法请参见获取单个专属分布式存储池详情中“表3 响应参数”的ID字段。 |
cluster_type
|
string | 否 |
云服务器系统盘对应的磁盘存储类型。仅用作专属云集群,固定取值为dss。 |
hw:passthrough
|
boolean | 否 |
|
metadata
|
VolumeMetadata object | 否 |
云硬盘加密信息,仅在创建节点系统盘或数据盘需加密时须填写。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
__system__encrypted
|
string | 否 |
表示云硬盘加密功能的字段,'0'代表不加密,'1'代表加密。 该字段不存在时,云硬盘默认为不加密。 |
__system__cmkid
|
string | 否 |
用户主密钥ID,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
size
|
integer | 是 |
磁盘大小,单位为GB
|
volumetype
|
string | 是 |
磁盘类型,取值请参见创建云服务器 中“root_volume字段数据结构说明”。
|
extendParam
|
Map<String,Object> | 否 |
磁盘扩展参数,取值请参见创建云服务器中“extendparam”参数的描述。 链接请参见创建云服务器 |
cluster_id
|
string | 否 |
云服务器系统盘对应的存储池的ID。仅用作专属云集群,专属分布式存储DSS的存储池ID,即dssPoolID。 获取方法请参见获取单个专属分布式存储池详情中“表3 响应参数”的ID字段。 |
cluster_type
|
string | 否 |
云服务器系统盘对应的磁盘存储类型。仅用作专属云集群,固定取值为dss。 |
hw:passthrough
|
boolean | 否 |
|
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的索引,因此各个selector间的名字不能重复。 |
storageType
|
string | 是 |
存储类型,当前仅支持evs(云硬盘)或local(本地盘);local存储类型不支持磁盘选择,所有本地盘将被组成一个VG,因此也仅允许只有一个local类型的storageSelector。 |
matchLabels
|
matchLabels object | 否 |
evs盘的匹配字段,支持DataVolume中的size、volumeType、metadataEncrypted、metadataCmkid、count五个字段。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
size
|
string | 否 |
匹配的磁盘大小,不填则无磁盘大小限制。例如:100. |
volumeType
|
string | 否 |
云硬盘类型,目前支持SSD\GPSSD\SAS三种。 |
metadataEncrypted
|
string | 否 |
磁盘加密标识符,0代表不加密,1代表加密。 |
metadataCmkid
|
string | 否 |
加密磁盘的用户主密钥ID,长度为36字节的字符串。 |
count
|
string | 否 |
磁盘选择个数,不填则选择所有此类磁盘。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
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中空间配置的详细管理。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
name
|
string | 是 |
virtualSpace的名称,当前仅支持三种类型:kubernetes、runtime、user。
|
size
|
string | 是 |
virtualSpace的大小,仅支持整数百分比。例如:90%。
|
lvmConfig
|
LVMConfig object | 否 |
lvm配置管理,适用于kubernetes和user空间配置。 需要注意:一个virtualSpace仅支持一个config配置。 |
runtimeConfig
|
RuntimeConfig object | 否 |
runtime配置管理,适用于运行时空间配置。 需要注意:一个virtualSpace仅支持一个config配置。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
lvType
|
string | 是 |
LVM写入模式:linear、striped。linear:线性模式;striped:条带模式,使用多块磁盘组成条带模式,能够提升磁盘性能。 |
path
|
string | 否 |
磁盘挂载路径。仅在用户配置中生效。支持包含:数字、大小写字母、点、中划线、下划线的绝对路径。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
lvType
|
string | 是 |
LVM写入模式:linear、striped。linear:线性模式;striped:条带模式,使用多块磁盘组成条带模式,能够提升磁盘性能。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ids
|
Array of strings | 否 |
已有的弹性IP的ID列表。数量不得大于待创建节点数
|
count
|
integer | 否 |
要动态创建的弹性IP个数。
|
eip
|
NodeEIPSpec object | 否 |
弹性IP参数 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
iptype
|
string | 是 |
弹性IP类型,取值请参见申请EIP接口中publicip.type说明。 链接请参见申请EIP |
bandwidth
|
NodeBandwidth object | 否 |
弹性IP的带宽参数 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
chargemode
|
string | 否 |
带宽的计费类型:
|
size
|
integer | 否 |
带宽大小,取值请参见取值请参见申请EIP接口中bandwidth.size说明。 链接请参见申请EIP |
sharetype
|
string | 否 |
带宽的共享类型,共享类型枚举:PER,表示独享。WHOLE,表示共享。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
primaryNic
|
NicSpec object | 否 |
主网卡的描述信息。 |
extNics
|
Array of NicSpec objects | 否 |
扩展网卡
|
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
subnetId
|
string | 否 |
网卡所在子网的网络ID。主网卡创建时若未指定subnetId,将使用集群子网。拓展网卡创建时必须指定subnetId。 |
fixedIps
|
Array of strings | 否 |
主网卡的IP将通过fixedIps指定,数量不得大于创建的节点数。fixedIps或ipBlock同时只能指定一个。 |
ipBlock
|
string | 否 |
主网卡的IP段的CIDR格式,创建的节点IP将属于该IP段内。fixedIps或ipBlock同时只能指定一个。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
subnetId
|
string | 否 |
网卡所在子网的网络ID。主网卡创建时若未指定subnetId,将使用集群子网。拓展网卡创建时必须指定subnetId。 |
fixedIps
|
Array of strings | 否 |
主网卡的IP将通过fixedIps指定,数量不得大于创建的节点数。fixedIps或ipBlock同时只能指定一个。 |
ipBlock
|
string | 否 |
主网卡的IP段的CIDR格式,创建的节点IP将属于该IP段内。fixedIps或ipBlock同时只能指定一个。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
key
|
string | 是 |
键 |
value
|
string | 否 |
值 |
effect
|
string | 是 |
作用效果 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
key
|
string | 否 |
云服务器标签的键。不得以"CCE-"或"__type_baremetal"开头 |
value
|
string | 否 |
云服务器标签的值 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
name
|
string | 否 |
容器运行时, 默认场景:
|
名称 | 类型 | 必选 |
---|---|---|
ecs:performancetype
|
string | 否 |
orderID
|
string | 否 |
productID
|
string | 否 |
maxPods
|
integer | 否 |
periodType
|
string | 否 |
periodNum
|
integer | 否 |
isAutoRenew
|
string | 否 |
isAutoPay
|
string | 否 |
DockerLVMConfigOverride
|
string | 否 |
dockerBaseSize
|
integer | 否 |
publicKey
|
string | 否 |
alpha.cce/preInstall
|
string | 否 |
alpha.cce/postInstall
|
string | 否 |
alpha.cce/NodeImageID
|
string | 否 |
nicMultiqueue
|
string | 否 |
nicThreshold
|
string | 否 |
chargingMode
|
integer | 否 |
agency_name
|
string | 否 |
kube-reserved-mem
|
integer | 否 |
system-reserved-mem
|
integer | 否 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
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 | 否 |
删除资源时表示资源删除状态 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
previous_total
|
integer | 否 |
集群删除时已经存在的集群资源记录总数 |
current_total
|
integer | 否 |
基于当前集群资源记录信息,生成实际最新资源记录总数 |
updated
|
integer | 否 |
集群删除时更新的资源记录总数 |
added
|
integer | 否 |
集群删除时更新的资源记录总数 |
deleted
|
integer | 否 |
集群删除时删除的资源记录总数 |
表示获取集群下指定的节点成功。
"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"
}
}