節點池是具有相同屬性的一組節點的邏輯集合,允許對節點進行統一的管理和營運,例如節點升級、Auto Scaling等。您可以進一步使用節點池的自動化營運能力,使用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 |
否 |
自動Auto Scaling配置。 |
|
| enable |
boolean |
否 |
是否啟用自動調整,取值:
當取值為 false 時, 預設值: |
false |
| type |
string |
否 |
自動Auto Scaling執行個體類型。僅當
預設值: 重要 節點池建立後,該欄位不支援修改。 枚舉值:
|
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 |
否 |
節點修複是否需要人工審批。 |
|
| 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 |
| 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 金鑰識別碼。 |
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 |
否 |
資料盤配置。 |
||
| disk_init |
array |
否 |
塊裝置初始化配置。 |
|
|
DiskInit |
否 |
DiskInit 配置。 |
||
| 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 |
| 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**** |
| 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 節點上安裝CloudMonitor,安裝後可以在CloudMonitor控制台查看所建立 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_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 |
否 |
節點群組件自訂配置。 |
|
|
string |
否 |
節點群組件自訂配置字串。 |
cpuManagerPolicy |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
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-****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。