節點池是具有相同屬性的一組節點的邏輯集合,允許對節點進行統一的管理和運維,例如節點升級、彈性伸縮等。您可以進一步使用節點池的自動化運維能力,使用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 |
否 |
節點修復是否需要人工審批。 |
|
| 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 |
否 |
||
| 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 |
否 |
資料盤配置。 |
||
| 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 節點上安裝雲監控,安裝後可以在雲監控控制檯檢視所建立 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 |
否 |
节点组件自定义配置。 |
{"cpuManagerPolicy":"static"} |
|
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-****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。