節點池是具有相同屬性的一組節點的邏輯集合,允許對節點進行統一的管理和維運,例如節點升級、彈性伸縮等。您可以進一步使用節點池的自動化維運能力,使用 OS CVE 漏洞自動修復、故障節點自動恢復、kubelet 和 containerd 版本自動升級等功能,降低維運成本。您可以呼叫 CreateClusterNodePool 為叢集建立節點池。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cs:CreateClusterNodePool |
create |
*Cluster
|
無 | 無 |
請求文法
POST /clusters/{ClusterId}/nodepools HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ClusterId |
string |
是 |
叢集 ID。 |
c61da77e8bfbc4c4c999af2b51b65**** |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| body |
object |
否 |
請求體參數。 |
|
| nodepool_info |
object |
否 |
節點池設定。 |
|
| name |
string |
是 |
節點池名稱。 |
nodepool-test |
| type |
string |
否 |
節點池類型,取值範圍:
枚舉值:
|
ess |
| resource_group_id |
string |
否 |
節點池的資源群組 ID,節點池彈出的執行個體將屬於該資源群組內。 一個資源只能歸屬於一個資源群組。根據不同的業務場景,您可以將資源群組對應為專案、應用程式或組織等概念。 |
rg-acfmyvw3wjmb**** |
| auto_scaling |
object |
否 |
自動彈性伸縮設定。 |
|
| enable |
boolean |
否 |
是否啟用自動伸縮,取值:
當取值為 false 時, 預設值: |
false |
| type |
string |
否 |
自動彈性伸縮執行個體類型。僅當
預設值: 重要 節點池建立後,該欄位不支援修改。 枚舉值:
|
cpu |
| max_instances |
integer |
否 |
節點池中可伸縮的最大執行個體數,不包含您已有的執行個體。僅當 取值範圍 [min_instances, 2000],預設值為 0。 |
10 |
| min_instances |
integer |
否 |
節點池中可伸縮的最小執行個體數,不包含您已有的執行個體。僅當 取值範圍 [0, max_instances],預設值為 0。 說明
|
1 |
is_bond_eip
deprecated
|
boolean |
否 |
【該欄位已廢棄】該欄位已廢棄,請使用 internet_charge_type 和 internet_max_bandwidth_out 替代。 是否綁定 EIP。取值:
預設值: |
null |
eip_internet_charge_type
deprecated
|
string |
否 |
【該欄位已廢棄】請使用 internet_charge_type 和 internet_max_bandwidth_out 替代。 EIP 計費類型。取值:
預設值: |
null |
eip_bandwidth
deprecated
|
integer |
否 |
【該欄位已廢棄】請使用 internet_charge_type 和 internet_max_bandwidth_out 替代。 EIP 頻寬峰值。單位:Mbps。 |
null |
| management |
object |
否 |
節點池託管功能設定。 |
|
| enable |
boolean |
否 |
是否開啟節點池的託管功能,取值:
預設值:false。 |
false |
| auto_repair |
boolean |
否 |
是否自動修復節點,僅當
預設值為 |
true |
| auto_repair_policy |
object |
否 |
自動修復節點策略。 |
|
| restart_node |
boolean |
否 |
是否允許重新啟動節點,僅當
預設值為 |
true |
| approval_required |
boolean |
否 |
節點修復是否需要人工審批。 |
|
| max_parallel_repairing_nodes |
string |
否 |
最大平行修復數,節點池中存在大量異常節點時,最多允許同時修復的節點數或節點比例。支援數量(如 5,取值範圍 1~100000)或百分比(如 10%,取值範圍 1%~100%)。後端預設平行修復數:1。 |
5 |
| max_unhealthy_nodes_threshold |
string |
否 |
自癒熔斷條件,當發生故障的節點數或節點比例大於該閾值時,自癒進入熔斷狀態,並停止新增自癒修復動作。支援數量(如 10,取值範圍 1~100000)或百分比(如 20%,取值範圍 1%~100%)。後端預設熔斷條件為:100%。 |
20% |
| auto_vul_fix |
boolean |
否 |
是否自動修復 CVE 漏洞,僅當
預設值為 |
true |
| auto_vul_fix_policy |
object |
否 |
自動修復 CVE 策略。 |
|
| restart_node |
boolean |
否 |
是否允許重新啟動節點,僅當
預設值為 |
false |
| vul_level |
string |
否 |
允許自動修復的漏洞等級,以英文逗號分隔,例如:
預設值為 |
asap,nntf |
| exclude_packages |
string |
否 |
指定在漏洞修復過程中應排除的套件。 預設值為 |
kernel |
| auto_upgrade |
boolean |
否 |
是否自動升級節點,僅當
預設值為 |
true |
| auto_upgrade_policy |
object |
否 |
自動升級節點策略。 |
|
| auto_upgrade_kubelet |
boolean |
否 |
是否允許自動升級 kubelet,僅當
預設值為 |
true |
| auto_upgrade_runtime |
boolean |
否 |
是否允許自動升級執行環境,僅當
預設值為 |
false |
| auto_upgrade_os |
boolean |
否 |
是否允許自動升級作業系統,僅當
預設值為 |
false |
upgrade_config
deprecated
|
object |
否 |
【該欄位已廢棄】請使用上層的 自動升級設定,僅當 |
|
auto_upgrade
deprecated
|
boolean |
否 |
【該欄位已廢棄】請使用上層的 是否啟用自動升級,取值:
|
null |
| surge |
integer |
否 |
額外節點數量。和 升級的時候節點會無法使用,您可以建立額外節點補償叢集的負載。 說明
建議建立的額外節點不超過目前的節點數。 |
0 |
| surge_percentage |
integer |
否 |
額外節點數的百分比,和 額外節點數=額外節點數比例×節點數,例如,設定額外節點數比例為 50%,存在的節點數為 6,那麼將產生的額外節點數=50%×6,也就是將產生 3 個額外節點數。 |
0 |
| max_unavailable |
integer |
否 |
最大不可用節點數量。 取值範圍:[1,1000] 預設值:1。 |
1 |
| auto_fault_diagnosis |
boolean |
否 |
是否開啟節點自癒 ECS 故障偵測。 |
|
| drift_enabled |
boolean |
否 |
是否啟用節點輪轉能力。僅智慧託管節點池支援,且預設開啟;普通節點池暫不支援。 |
|
| scaling_group |
object |
否 |
節點集區伸縮群組設定。 |
|
| vswitch_ids |
array |
是 |
虛擬交換器 ID 清單,取值範圍:[1,8]。 說明
為保證高可用性,建議選擇不同可用區的虛擬交換器。 |
|
|
string |
否 |
虛擬交換器 ID。 |
vsw-wz9mfnhmssud6eicu**** |
|
| instance_types |
array |
是 |
節點集區節點執行個體規格清單,節點集區彈出節點時,將從指定的執行個體規格清單中,挑選出符合要求的執行個體規格彈出執行個體。 支援的執行個體規格數量範圍:[1,10] 說明
為保證高可用性,建議選擇多個執行個體規格。 |
|
|
string |
否 |
執行個體規格。請參見執行個體規格族。 |
ecs.d1ne.2xlarge |
|
| instance_charge_type |
string |
是 |
節點集區節點付費類型,取值:
預設值: 枚舉值:
|
PostPaid |
| period |
integer |
否 |
節點集區節點包年包月時長,僅當
|
1 |
| period_unit |
string |
否 |
節點集區節點付費週期,僅當
預設值: |
Month |
| auto_renew |
boolean |
否 |
節點集區節點是否啟用自動續費,當
預設值: |
true |
| auto_renew_period |
integer |
否 |
單次自動續費的續費時長。取值範圍:
預設值:1。 |
1 |
| spot_strategy |
string |
否 |
搶占式執行個體類型。取值:
更多資訊,請參見搶占式執行個體。 |
NoSpot |
| spot_price_limit |
array<object> |
否 |
目前單台搶占式執行個體規格市場價格區間設定。 |
|
|
object |
否 |
搶占執行個體市場價格區間設定,可為不同執行個體規格設定不同的價格區間。 |
||
| instance_type |
string |
否 |
搶占式執行個體規格。 |
ecs.c6.large |
| price_limit |
string |
否 |
單台執行個體上限價格。 單位:美元/小時。 |
0.39 |
| image_type |
string |
否 |
作業系統映像類型,取值範圍:
|
AliyunLinux3 |
| image_id |
string |
否 |
自訂映像 ID,預設使用系統提供的映像。 |
aliyun_2_1903_x64_20G_alibase_20200529.vhd |
| system_disk_category |
string |
否 |
節點系統磁碟類型,取值:
預設值: |
cloud_efficiency |
| system_disk_categories |
array |
否 |
系統磁碟的多磁碟類型。當無法使用高優先順序的磁碟類型時,自動嘗試下一優先順序的磁碟類型建立系統磁碟。 |
|
|
string |
否 |
節點的多系統磁碟類型。 取值範圍:
|
cloud_essd |
|
| system_disk_size |
integer |
否 |
節點系統磁碟大小,單位:GiB。 取值範圍:[20,2048]。 |
120 |
| system_disk_performance_level |
string |
否 |
節點系統磁碟磁碟效能,只對 ESSD 磁碟生效。磁碟效能等級和磁碟大小有關。更多資訊,請參見ESSD 雲端硬碟。
|
PL1 |
| system_disk_encrypted |
boolean |
否 |
是否加密系統磁碟。取值範圍:
|
false |
| system_disk_kms_key_id |
string |
否 |
系統磁碟使用的 KMS 金鑰 ID。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| system_disk_encrypt_algorithm |
string |
否 |
系統磁碟採用的加密演算法。取值範圍:aes-256。 |
aes-256 |
| system_disk_bursting_enabled |
boolean |
否 |
節點系統磁碟是否啟用 Burst(效能突發)。 取值:
當 |
true |
| system_disk_provisioned_iops |
integer |
否 |
節點系統磁碟預先配置的讀寫 IOPS。 可能值:0~min{50,000, 1000*容量-基準效能}。 基準效能=min{1,800+50*容量, 50000}。 當 |
1000 |
| data_disks |
array |
否 |
節點集區節點資料磁碟設定。 |
|
| data_disk |
否 |
資料磁碟設定。 |
||
| security_group_ids |
array |
否 |
安全性群組 ID 清單,與 |
|
|
string |
否 |
安全性群組 ID 清單,與 |
sg-wz9a8g2mt6x5ll****** |
|
| key_pair |
string |
否 |
免密登入金鑰對名稱,和 說明
如果節點集區選擇 ContainerOS 作業系統,則只支援 |
np-key-name |
| login_password |
string |
否 |
SSH 登入密碼,和 |
**** |
| login_as_non_root |
boolean |
否 |
彈出的 ECS 執行個體是否使用以非 root 使用者登入。
|
true |
cis_enabled
deprecated
|
boolean |
否 |
【已廢棄】請使用參數 security_hardening_os 替代。 |
null |
| soc_enabled |
boolean |
否 |
是否啟用等保加固,僅當系統映像選擇 Alibaba Cloud Linux 2 或 Alibaba Cloud Linux 3 時,可為節點啟用等保加固。阿里雲為 Alibaba Cloud Linux 2 和 Alibaba Cloud Linux 3 等保 2.0 三級版映像提供等保合規的基線檢查標準和掃描程式。 |
false |
| security_hardening_os |
boolean |
否 |
阿里雲 OS 安全性加固。取值:
預設值: |
false |
| internet_charge_type |
string |
否 |
公網 IP 收費類型。取值:
|
PayByTraffic |
| internet_max_bandwidth_out |
integer |
否 |
節點公網 IP 出頻寬最大值,單位為 Mbps(Mega bit per second),取值範圍:[1,100]。 |
5 |
| tags |
array<object> |
否 |
僅為 ECS 執行個體新增標籤。 標籤鍵不可以重複,最大長度為 128 個字元;標籤鍵和標籤值都不能以「aliyun」、「acs:」開頭,或包含「https://」、「http://」。 |
|
|
object |
否 |
節點標籤。 |
||
| key |
string |
否 |
標籤的名稱。 |
node-k-1 |
| value |
string |
否 |
標籤值。 |
node-v-1 |
| desired_size |
integer |
否 |
節點集區期望節點數量。 節點集區應該維持的總節點數量,建議至少配置 2 個節點,以確保叢集元件正常運行。您可以透過調整期望節點數,達到擴容或縮容節點集區的目的。 如無需建立節點,可填寫為 0,後續再手動調整,增加節點數。 |
0 |
| multi_az_policy |
string |
否 |
多可用區伸縮群組 ECS 執行個體擴縮容策略。取值:
預設值: |
COST_OPTIMIZED |
| scaling_policy |
string |
否 |
伸縮群組模式,取值:
預設值: |
release |
| on_demand_base_capacity |
integer |
否 |
伸縮群組所需要隨用隨付執行個體個數的最小值,取值範圍:[0,1000]。當隨用隨付執行個體個數少於該值時,將優先建立隨用隨付執行個體。 |
0 |
| on_demand_percentage_above_base_capacity |
integer |
否 |
伸縮群組滿足最小隨用隨付執行個體數( |
20 |
| spot_instance_pools |
integer |
否 |
指定可用執行個體規格的個數,伸縮群組將按成本最低的多個規格均衡建立搶占式執行個體。取值範圍:[1,10]。 |
5 |
| spot_instance_remedy |
boolean |
否 |
是否開啟補齊搶占式執行個體。開啟後,當收到搶占式執行個體將被回收的系統訊息時,伸縮群組將嘗試建立新的執行個體,替換掉將被回收的搶占式執行個體。取值:
|
false |
| compensate_with_on_demand |
boolean |
否 |
當
|
true |
| enable_high_density_mode |
boolean |
否 |
是否開啟高密度雲端硬碟模式。僅在節點集區使用執行個體規格時支援,開啟後系統磁碟與資料磁碟之和不超過規格支援的高密度雲端硬碟數量。 |
false |
| deploymentset_id |
string |
否 |
部署集 ID。您可以使用部署集將節點集區彈出的 ECS 執行個體分散部署在不同的實體伺服器上,以保證業務的高可用性和底層容災能力。在部署集內建立 ECS 執行個體時,根據事先設定的部署策略,分散啟動指定地域下的 ECS 執行個體。 重要 選擇部署集後,節點集區內最大節點數會受限。部署集預設支援節點上限為 20 * 可用區數量(可用區數量由虛擬交換器決定)。請謹慎選擇,確保部署集內配額充足,避免節點弹出失敗。 |
ds-bp1d19mmbsv3jf6xxxxx |
| rds_instances |
array |
否 |
RDS 執行個體列表。 |
|
|
string |
否 |
RDS 執行個體 ID。 |
rds-**** |
|
| private_pool_options |
object |
否 |
私有節點集區配置。 |
|
| id |
string |
否 |
私有節點集區 ID。當 |
eap-bp67acfmxazb4**** |
| match_criteria |
string |
否 |
私有節點集區類型,執行個體啟動的私有池容量選項。彈性保障服務或容量預定服務在生效後會生成私有池容量,供執行個體啟動時選擇。取值:
|
Target |
security_group_id
deprecated
|
string |
否 |
節點集區安全性群組 ID,與 |
sg-wz9a8g2mt6x5llu0**** |
platform
deprecated
|
string |
否 |
【該欄位已廢棄】請使用 作業系統發行版。取值:
預設值: |
null |
| instance_patterns |
array |
否 |
執行個體屬性配置。 |
|
| instance_patterns |
否 |
執行個體屬性。 |
||
| ram_role_name |
string |
否 |
Worker RAM 角色名稱。
重要 僅 1.22 及以上版本的 ACK 託管叢集支援該參數 |
example-role |
| instance_metadata_options | InstanceMetadataOptions |
否 |
ECS 執行個體中繼資料存取配置。 |
|
| resource_pool_options |
object |
否 |
建立執行個體時使用的資源池及資源池策略。當您設定該參數後,需要注意: 該參數只在建立隨用隨付執行個體時生效。 該參數不能與 private_pool_options.match_criteria、private_pool_options.id 同時設定。 |
|
| strategy |
string |
否 |
建立執行個體時使用的資源池策略。資源池包括彈性保障服務或容量預定服務生效後生成的私有池以及公共池,供執行個體啟動時選擇。取值範圍: PrivatePoolFirst:私有池優先。選擇此種策略時, 當指定了 resouce_pool_options.private_pool_ids,優先使用指定的私有池。如果未指定私有池或指定的私有池容量不足,將自動匹配開放類型的私有池。如果沒有符合條件的私有池,則使用公共池建立執行個體。 PrivatePoolOnly:僅限私有池。選擇此種策略時,必須指定 resouce_pool_options.private_pool_ids。如果指定的私有池容量不足,則執行個體會啟動失敗。 None:不使用資源池策略。 預設值:None。 |
PrivatePoolFirst |
| private_pool_ids |
array |
否 |
私有池 ID 列表。即彈性保障服務 ID 或容量預定服務 ID。該參數只能傳入 Target 模式私有池 ID。N 的取值範圍:1~20。 |
|
|
string |
否 |
私有池 ID。即彈性保障服務 ID 或容量預定服務 ID。該參數只能傳入 Target 模式私有池 ID。 |
eap-bp67acfmxazb4**** |
|
| system_disk_snapshot_policy_id |
string |
否 |
系統磁碟快照策略。 |
sp-0jl6xnmme8v7o935**** |
| disk_init |
array |
否 |
區塊裝置初始化配置。 |
|
|
DiskInit |
否 |
DiskInit 配置。 |
||
| cpu_options |
object |
否 |
CPU 相關配置選項。 |
|
| nested_virtualization |
string |
否 |
是否開啟巢狀虛擬化。取值範圍:disabled:關閉巢狀虛擬化。enabled:開啟巢狀虛擬化。 |
enabled |
| node_config |
object |
否 |
節點設定。 |
|
| kubelet_configuration | kubelet_config |
否 |
Kubelet 參數設定。 |
|
| kubernetes_config |
object |
否 |
叢集相關設定。 |
|
| labels |
array |
否 |
節點標籤,為 Kubernetes 叢集節點新增標籤。 |
|
| tag |
否 |
標籤設定。 |
||
| taints |
array |
否 |
污點設定。 |
|
| taint |
否 |
污點設定集合。 |
||
| runtime |
string |
否 |
容器執行環境名稱,ACK 支援以下三種容器執行環境。
預設值:containerd。 |
containerd |
| runtime_version |
string |
否 |
容器執行環境版本。 |
1.6.38 |
| cpu_policy |
string |
否 |
節點 CPU 管理策略。當叢集版本在 1.12.6 及以上時支援以下兩種策略:
預設值: |
none |
| user_data |
string |
否 |
執行個體自訂資料。節點加入叢集後,將執行您指定的執行個體自訂資料指令碼。請參見 User-Data 指令碼。 |
dGhpcyBpcyBhIGV4YW1wbGU= |
| unschedulable |
boolean |
否 |
擴容後的節點是否不可排程。
|
true |
| cms_enabled |
boolean |
否 |
是否在 ECS 節點上安裝雲端監控,安裝後可以在雲端監控主控台檢視所建立 ECS 執行個體的監控資訊,建議開啟。取值:
預設值: |
false |
| node_name_mode |
string |
否 |
自訂節點名稱。自訂節點名稱後,將同時變更節點名稱、ECS 執行個體名稱、ECS 執行個體 Hostname。 說明
對於開啟自訂節點名稱的 Windows 執行個體,其 Hostname 固定為 IP 位址,使用 - 代替 IP 位址中的 .,且不包含前綴和後綴。 節點名稱由前綴、節點 IP 位址及後綴三部分組成:
例如:節點 IP 位址為 192.XX.YY.55,指定前綴為 aliyun.com,後綴為 test。
|
aliyun.com192.XX.YY.55test |
| pre_user_data |
string |
否 |
執行個體預先自訂資料。節點加入叢集前,將執行您指定的執行個體預先自訂資料指令碼。請參見 User-Data 指令碼。 |
dGhpcyBpcyBhIGV4YW1wbGU |
| tee_config |
object |
否 |
加密運算叢集設定。 |
|
| tee_enable |
boolean |
否 |
是否啟用加密運算叢集。
|
true |
interconnect_config
deprecated
|
object |
否 |
【該欄位已廢棄】 邊緣節點池設定。 |
|
| cen_id |
string |
否 |
【該欄位已廢棄】 邊緣增強型節點池綁定的雲企業網執行個體 ID (CENID)。 |
null |
| ccn_id |
string |
否 |
【該欄位已廢棄】 邊緣增強型節點池綁定的雲連接網執行個體 ID (CCNID)。 |
null |
| ccn_region_id |
string |
否 |
【該欄位已廢棄】 邊緣增強型節點池綁定的雲連接網執行個體所屬的地域。 |
null |
| bandwidth |
integer |
否 |
【該欄位已廢棄】 邊緣增強型節點池的網路頻寬,單位:Mbps。 |
null |
| improved_period |
string |
否 |
【該欄位已廢棄】 邊緣增強型節點池的購買時長,單位:月。 |
null |
count
deprecated
|
integer |
否 |
【該欄位已廢棄】請使用 desired_size 代替。 節點池節點數量。 |
null |
max_nodes
deprecated
|
integer |
否 |
【該欄位已廢棄】 邊緣節點池允許容納的最大節點數量。 |
null |
| interconnect_mode |
string |
否 |
邊緣節點池的網路類型,該參數僅對
|
basic |
| host_network |
boolean |
否 |
Pod 網路模式是否採用主機網路模式。
|
true |
| intranet |
boolean |
否 |
邊緣節點池內,節點之間是否三層網路互通。
|
true |
| eflo_node_group |
object |
否 |
靈駿節點池設定。 |
|
| cluster_id |
string |
否 |
建立靈駿節點池時需要關聯的靈駿叢集 ID。 |
i1169130516633730**** |
| group_id |
string |
否 |
建立靈駿節點池時需要關聯的靈駿叢集的靈駿分組 ID。 |
ng-ec3c96ff0aa**** |
| auto_attach_enabled |
boolean |
否 |
是否啟用靈駿節點池自動新增。 |
|
| worker_ram_role_name |
string |
否 |
靈駿節點池所使用的 Worker Ram Role。 |
|
| auto_mode |
object |
否 |
節點池智慧託管設定。 |
|
| enable |
boolean |
否 |
是否啟用智慧託管模式。 取值:
|
true |
| node_components |
array<object> |
否 |
節點元件清單。 |
|
|
array<object> |
否 |
節點元件。 |
||
| name |
string |
否 |
節點元件名稱。 |
kubelet |
| version |
string |
否 |
節點元件版本。 |
1.33.3-aliyun.1 |
| config |
object |
否 |
節點元件設定。 |
|
| custom_config |
object |
否 |
節點元件自訂設定。 |
{"cpuManagerPolicy":"static"} |
|
any |
否 |
節點元件自訂設定字串。 |
cpuManagerPolicy |
|
| envs |
array<object> |
否 |
節點元件環境變數。 |
|
|
object |
否 |
|||
| name |
string |
否 |
環境變數名稱。 |
LOG_LEVEL |
| value |
string |
否 |
環境變數值。 |
info |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
節點池設定。 |
||
| nodepool_id |
string |
節點池 ID。 |
np31da1b38983f4511b490fc62108a**** |
| task_id |
string |
任務 ID。 |
T-613b19bbd160ad492800**** |
| request_id |
string |
請求 ID。 |
0527ac9a-c899-4341-a21a-**** |
樣本
正常返回樣本
JSON格式
{
"nodepool_id": "np31da1b38983f4511b490fc62108a****",
"task_id": "T-613b19bbd160ad492800****",
"request_id": "0527ac9a-c899-4341-a21a-****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。