該API用于通過節(jié)點ID獲取指定節(jié)點的詳細信息。
集群管理的URL格式為:https://Endpoint/uri。其中uri為資源路徑,也即API訪問的路徑。
名稱 | 類型 | IN | 必選 | 描述 |
---|---|---|---|---|
Content-Type
|
string | header | 是 |
消息體的類型(格式) |
X-Auth-Token
|
string | header | 是 |
調(diào)用接口的認證方式分為Token和AK/SK兩種,如果您使用的Token方式,此參數(shù)為必填,請?zhí)顚慣oken的值,獲取方式請參見獲取token。 |
project_id
|
string | path | 是 |
項目ID,獲取方式請參見如何獲取接口URI中參數(shù)。 |
cluster_id
|
string | path | 是 |
集群ID,獲取方式請參見如何獲取接口URI中參數(shù)。 |
node_id
|
string | path | 是 |
節(jié)點ID,獲取方式請參見如何獲取接口URI中參數(shù)。 |
表示獲取集群下指定的節(jié)點成功。
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
kind
|
string | 否 |
API類型,固定值“Node”,該值不可修改。 |
apiVersion
|
string | 否 |
API版本,固定值“v3”,該值不可修改。 |
metadata
|
NodeMetadata object | 否 |
metadata是節(jié)點對象的元數(shù)據(jù)定義,是集合類的元素類型,包含一組由不同名稱定義的屬性。 |
spec
|
NodeSpec object | 否 |
spec是集合類的元素類型,用戶對需要管理的節(jié)點對象進行詳細描述的主體部分都在spec中給出。系統(tǒng)通過spec的描述來創(chuàng)建或更新對象。 |
status
|
NodeStatus object | 否 |
節(jié)點狀態(tài),動態(tài)記錄,創(chuàng)建或修改時指定無意義. |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
name
|
string | 否 |
節(jié)點名稱
|
uid
|
string | 否 |
節(jié)點ID,資源唯一標識,創(chuàng)建成功后自動生成,填寫無效 |
labels
|
Map<String,String> | 否 |
CCE自有節(jié)點標簽,非Kubernetes原生labels。 標簽可用于選擇對象并查找滿足某些條件的對象集合,格式為key/value鍵值對。 示例:
|
annotations
|
Map<String,String> | 否 |
CCE自有節(jié)點注解,非Kubernetes原生annotations,格式為key/value鍵值對。 示例:
|
creationTimestamp
|
string | 否 |
創(chuàng)建時間,創(chuàng)建成功后自動生成,填寫無效 |
updateTimestamp
|
string | 否 |
更新時間,創(chuàng)建成功后自動生成,填寫無效 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
flavor
|
string | 是 |
節(jié)點的規(guī)格,CCE支持的節(jié)點規(guī)格請參考節(jié)點規(guī)格說明獲取。 |
az
|
string | 是 |
待創(chuàng)建節(jié)點所在的可用區(qū),需要指定可用區(qū)(AZ)的名稱。 CCE支持的可用區(qū)請參考地區(qū)和終端節(jié)點 |
os
|
string | 否 |
節(jié)點的操作系統(tǒng)類型。具體支持的操作系統(tǒng)請參見節(jié)點操作系統(tǒng)說明。
|
login
|
Login object | 是 |
節(jié)點的登錄方式。密鑰對和密碼登錄方式二者必選其一。 |
rootVolume
|
Volume object | 是 |
節(jié)點的磁盤信息 |
dataVolumes
|
Array of Volume objects | 是 |
節(jié)點的數(shù)據(jù)盤參數(shù)(目前已支持通過控制臺為CCE節(jié)點添加第二塊數(shù)據(jù)盤)。 如果數(shù)據(jù)盤正供容器運行時和Kubelet組件使用,則不可被卸載,否則將導致節(jié)點不可用。 針對專屬云節(jié)點,參數(shù)解釋與rootVolume一致 |
storage
|
Storage object | 否 |
磁盤初始化配置管理參數(shù)。 該參數(shù)配置邏輯較為復雜,詳細說明請參見節(jié)點磁盤掛載。 該參數(shù)缺省時,按照extendParam中的DockerLVMConfigOverride(已廢棄)參數(shù)進行磁盤管理。此參數(shù)對1.15.11及以上集群版本支持。
|
publicIP
|
NodePublicIP object | 否 |
節(jié)點的 彈性公網(wǎng)IP
|
nodeNicSpec
|
NodeNicSpec object | 否 |
節(jié)點的網(wǎng)卡信息 |
count
|
integer | 否 |
批量創(chuàng)建時節(jié)點的個數(shù),必須為大于等于1,小于等于最大限額的正整數(shù)。作用于節(jié)點池時該項可以不填寫。 |
billingMode
|
integer | 否 |
節(jié)點的計費模式:
|
taints
|
Array of Taint objects | 否 |
支持給創(chuàng)建出來的節(jié)點加Taints來設置反親和性,taints配置不超過20條。每條Taints包含以下3個參數(shù):
示例:
|
k8sTags
|
Map<String,String> | 否 |
格式為key/value鍵值對。鍵值對個數(shù)不超過20條。
示例:
|
ecsGroupId
|
string | 否 |
云服務器 組ID,若指定,將節(jié)點創(chuàng)建在該云服務器組下 |
dedicatedHostId
|
string | 否 |
指定DeH主機的ID,將節(jié)點調(diào)度到自己的DeH上。
|
userTags
|
Array of UserTag objects | 否 |
云服務器標簽,鍵必須唯一,CCE支持的最大用戶自定義標簽數(shù)量依region而定,自定義標簽數(shù)上限為8個。 字段使用場景:在節(jié)點創(chuàng)建場景下,支持指定初始值,查詢時不返回該字段;在節(jié)點池場景下,其中節(jié)點模板中支持指定初始值,查詢時支持返回該字段;在其余場景下,查詢時都不會返回該字段。 |
runtime
|
Runtime object | 否 |
容器運行時, 默認場景:
|
initializedConditions
|
Array of strings | 否 |
自定義初始化標記。 CCE節(jié)點在初始化完成之前,會打上初始化未完成污點(node.cloudprovider.kubernetes.io/uninitialized)防止pod調(diào)度到節(jié)點上。 cce支持自定義初始化標記,在接收到initializedConditions參數(shù)后,會將參數(shù)值轉(zhuǎn)換成節(jié)點標簽,隨節(jié)點下發(fā),例如:cloudprovider.openvessel.io/inject-initialized-conditions=CCEInitial_CustomedInitial。 當節(jié)點上設置了此標簽,會輪詢節(jié)點的status.Conditions,查看conditions的type是否存在標記名,如CCEInitial、CustomedInitial標記,如果存在所有傳入的標記,且狀態(tài)為True,認為節(jié)點初始化完成,則移除初始化污點。
|
extendParam
|
NodeExtendParam object | 否 |
創(chuàng)建節(jié)點時的擴展參數(shù)。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
sshKey
|
string | 否 |
選擇密鑰對方式登錄時的密鑰對名稱。 |
userPassword
|
UserPassword object | 否 |
選擇密碼方式登錄時的帳號密碼信息,之后可通過此帳號密碼登錄節(jié)點。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
username
|
string | 否 |
登錄帳號,默認為“root” |
password
|
string | 是 |
登錄密碼,若創(chuàng)建節(jié)點通過用戶名密碼方式,即使用該字段,則響應體中該字段作屏蔽展示。 密碼復雜度要求:
|
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
size
|
integer | 是 |
磁盤大小,單位為GB
|
volumetype
|
string | 是 |
磁盤類型,取值請參見創(chuàng)建云服務器 中“root_volume字段數(shù)據(jù)結(jié)構(gòu)說明”。
|
extendParam
|
Map<String,Object> | 否 |
磁盤擴展參數(shù),取值請參見創(chuàng)建云服務器中“extendparam”參數(shù)的描述。 鏈接請參見創(chuàng)建云服務器 |
cluster_id
|
string | 否 |
云服務器系統(tǒng)盤對應的存儲池的ID。僅用作專屬云集群, 專屬分布式存儲 DSS的存儲池ID,即dssPoolID。 獲取方法請參見獲取單個專屬分布式存儲池詳情中“表3 響應參數(shù)”的ID字段。 |
cluster_type
|
string | 否 |
云服務器系統(tǒng)盤對應的磁盤存儲類型。僅用作專屬云集群,固定取值為dss。 |
hw:passthrough
|
boolean | 否 |
|
metadata
|
VolumeMetadata object | 否 |
云硬盤加密信息,僅在創(chuàng)建節(jié)點系統(tǒng)盤或數(shù)據(jù)盤需加密時須填寫。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
__system__encrypted
|
string | 否 |
表示云硬盤加密功能的字段,'0'代表不加密,'1'代表加密。 該字段不存在時,云硬盤默認為不加密。 |
__system__cmkid
|
string | 否 |
用戶主密鑰ID,是metadata中的表示加密功能的字段,與__system__encrypted配合使用。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
size
|
integer | 是 |
磁盤大小,單位為GB
|
volumetype
|
string | 是 |
磁盤類型,取值請參見創(chuàng)建云服務器 中“root_volume字段數(shù)據(jù)結(jié)構(gòu)說明”。
|
extendParam
|
Map<String,Object> | 否 |
磁盤擴展參數(shù),取值請參見創(chuàng)建云服務器中“extendparam”參數(shù)的描述。 鏈接請參見創(chuàng)建云服務器 |
cluster_id
|
string | 否 |
云服務器系統(tǒng)盤對應的存儲池的ID。僅用作專屬云集群,專屬分布式存儲DSS的存儲池ID,即dssPoolID。 獲取方法請參見獲取單個專屬分布式存儲池詳情中“表3 響應參數(shù)”的ID字段。 |
cluster_type
|
string | 否 |
云服務器系統(tǒng)盤對應的磁盤存儲類型。僅用作專屬云集群,固定取值為dss。 |
hw:passthrough
|
boolean | 否 |
|
metadata
|
VolumeMetadata object | 否 |
云硬盤加密信息,僅在創(chuàng)建節(jié)點系統(tǒng)盤或數(shù)據(jù)盤需加密時須填寫。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
__system__encrypted
|
string | 否 |
表示云硬盤加密功能的字段,'0'代表不加密,'1'代表加密。 該字段不存在時,云硬盤默認為不加密。 |
__system__cmkid
|
string | 否 |
用戶主密鑰ID,是metadata中的表示加密功能的字段,與__system__encrypted配合使用。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
storageSelectors
|
Array of StorageSelectors objects | 是 |
磁盤選擇,根據(jù)matchLabels和storageType對匹配的磁盤進行管理。磁盤匹配存在先后順序,靠前的匹配規(guī)則優(yōu)先匹配。 |
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字節(jié)的字符串。 |
count
|
string | 否 |
磁盤選擇個數(shù),不填則選擇所有此類磁盤。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
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的大小,僅支持整數(shù)百分比。例如:90%。
|
lvmConfig
|
LVMConfig object | 否 |
lvm配置管理,適用于kubernetes和user空間配置。 需要注意:一個virtualSpace僅支持一個config配置。 |
runtimeConfig
|
RuntimeConfig object | 否 |
runtime配置管理,適用于運行時空間配置。 需要注意:一個virtualSpace僅支持一個config配置。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
lvType
|
string | 是 |
LVM寫入模式:linear、striped。linear:線性模式;striped:條帶模式,使用多塊磁盤組成條帶模式,能夠提升磁盤性能。 |
path
|
string | 否 |
磁盤掛載路徑。僅在用戶配置中生效。支持包含:數(shù)字、大小寫字母、點、中劃線、下劃線的絕對路徑。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
lvType
|
string | 是 |
LVM寫入模式:linear、striped。linear:線性模式;striped:條帶模式,使用多塊磁盤組成條帶模式,能夠提升磁盤性能。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
ids
|
Array of strings | 否 |
已有的彈性IP的ID列表。數(shù)量不得大于待創(chuàng)建節(jié)點數(shù)
|
count
|
integer | 否 |
要動態(tài)創(chuàng)建的彈性IP個數(shù)。
|
eip
|
NodeEIPSpec object | 否 |
彈性IP參數(shù) |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
iptype
|
string | 是 |
彈性IP類型,取值請參見申請EIP接口中publicip.type說明。 鏈接請參見申請EIP |
bandwidth
|
NodeBandwidth object | 否 |
彈性IP的帶寬參數(shù) |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
chargemode
|
string | 否 |
帶寬的計費類型:
|
size
|
integer | 否 |
帶寬大小,取值請參見取值請參見申請EIP接口中bandwidth.size說明。 鏈接請參見申請EIP |
sharetype
|
string | 否 |
帶寬的共享類型,共享類型枚舉:PER,表示獨享。WHOLE,表示共享。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
primaryNic
|
NicSpec object | 否 |
主網(wǎng)卡的描述信息。 |
extNics
|
Array of NicSpec objects | 否 |
擴展網(wǎng)卡
|
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
subnetId
|
string | 否 |
網(wǎng)卡所在子網(wǎng)的網(wǎng)絡ID。主網(wǎng)卡創(chuàng)建時若未指定subnetId,將使用集群子網(wǎng)。拓展網(wǎng)卡創(chuàng)建時必須指定subnetId。 |
fixedIps
|
Array of strings | 否 |
主網(wǎng)卡的IP將通過fixedIps指定,數(shù)量不得大于創(chuàng)建的節(jié)點數(shù)。fixedIps或ipBlock同時只能指定一個。 |
ipBlock
|
string | 否 |
主網(wǎng)卡的IP段的CIDR格式,創(chuàng)建的節(jié)點IP將屬于該IP段內(nèi)。fixedIps或ipBlock同時只能指定一個。 |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
subnetId
|
string | 否 |
網(wǎng)卡所在子網(wǎng)的網(wǎng)絡ID。主網(wǎng)卡創(chuàng)建時若未指定subnetId,將使用集群子網(wǎng)。拓展網(wǎng)卡創(chuàng)建時必須指定subnetId。 |
fixedIps
|
Array of strings | 否 |
主網(wǎng)卡的IP將通過fixedIps指定,數(shù)量不得大于創(chuàng)建的節(jié)點數(shù)。fixedIps或ipBlock同時只能指定一個。 |
ipBlock
|
string | 否 |
主網(wǎng)卡的IP段的CIDR格式,創(chuàng)建的節(jié)點IP將屬于該IP段內(nèi)。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 | 否 |
節(jié)點狀態(tài):節(jié)點資源生命周期管理(如安裝卸載等)狀態(tài)和集群內(nèi)k8s node狀態(tài)的綜合體現(xiàn),取值如下
|
lastProbeTime
|
string | 否 |
節(jié)點最近一次狀態(tài)檢查時間。集群處于異常、凍結(jié)或者中間態(tài)(例如創(chuàng)建中)時,節(jié)點的狀態(tài)檢查動作可能受影響。檢查時間超過5分的節(jié)點狀態(tài)不具有參考意義。 |
jobID
|
string | 否 |
創(chuàng)建或刪除時的任務ID。 |
serverId
|
string | 否 |
底層云服務器或裸金屬節(jié)點ID。 |
privateIP
|
string | 否 |
節(jié)點主網(wǎng)卡私有網(wǎng)段IP地址。 |
privateIPv6IP
|
string | 否 |
節(jié)點主網(wǎng)卡私有網(wǎng)段IPv6地址。 |
publicIP
|
string | 否 |
節(jié)點彈性 公網(wǎng)IP 地址。如果ECS的數(shù)據(jù)沒有實時同步,可在界面上通過“同步節(jié)點信息”手動進行更新。 |
deleteStatus
|
DeleteStatus object | 否 |
刪除資源時表示資源刪除狀態(tài) |
名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
previous_total
|
integer | 否 |
集群刪除時已經(jīng)存在的集群資源記錄總數(shù) |
current_total
|
integer | 否 |
基于當前集群資源記錄信息,生成實際最新資源記錄總數(shù) |
updated
|
integer | 否 |
集群刪除時更新的資源記錄總數(shù) |
added
|
integer | 否 |
集群刪除時更新的資源記錄總數(shù) |
deleted
|
integer | 否 |
集群刪除時刪除的資源記錄總數(shù) |
表示獲取集群下指定的節(jié)點成功。
"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"
}
}