您可以根據節點池 ID,呼叫 ModifyClusterNodePool 介面更新目標節點池的設定。
介面說明
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cs:ModifyClusterNodePool |
update |
*Cluster
|
無 | 無 |
請求文法
PUT /clusters/{ClusterId}/nodepools/{NodepoolId} HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ClusterId |
string |
是 |
叢集 ID。 |
c23421cfa74454bc8b37163fd19af**** |
| NodepoolId |
string |
是 |
節點池 ID。 |
p31da1b38983f4511b490fc62108a**** |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| body |
object |
否 |
請求體參數。 |
|
| nodepool_info |
object |
否 |
節點池設定。 |
|
| name |
string |
否 |
節點池名稱。 |
default-nodepool |
| resource_group_id |
string |
否 |
節點池的資源群組 ID,節點池彈出的執行個體將屬於該資源群組內。 |
rg-acfmyvw3wjm**** |
| auto_scaling |
object |
否 |
自動伸縮設定。 |
|
| enable |
boolean |
否 |
是否啟用自動伸縮,取值:
當取值為 false 時, 預設值: |
true |
type
deprecated
|
string |
否 |
自動伸縮類型,按照自動伸縮執行個體類型劃分。取值:
預設值: |
cpu |
| max_instances |
integer |
否 |
節點池中可伸縮的最大執行個體數,不包含您已有的執行個體。僅當 |
10 |
| min_instances |
integer |
否 |
節點池中可伸縮的最小執行個體數,不包含您已有的執行個體。僅當 取值範圍 [0, max_instances],預設值為 0。 說明
|
2 |
is_bond_eip
deprecated
|
boolean |
否 |
【該欄位已廢棄】該欄位已廢棄,請使用 internet_charge_type 和 internet_max_bandwidth_out 替代。 |
null |
eip_internet_charge_type
deprecated
|
string |
否 |
【該欄位已廢棄】請使用 internet_charge_type 和 internet_max_bandwidth_out 替代。 |
null |
eip_bandwidth
deprecated
|
integer |
否 |
【該欄位已廢棄】請使用 internet_charge_type 和 internet_max_bandwidth_out 替代。 |
null |
| management |
object |
否 |
託管節點池設定。 |
|
| enable |
boolean |
否 |
是否啟用託管節點池,取值:
預設值: |
true |
| auto_repair |
boolean |
否 |
是否自動修復節點,僅當 |
true |
| auto_repair_policy |
object |
否 |
自動修復節點策略。 |
|
| restart_node |
boolean |
否 |
是否允許重新啟動節點,僅當 |
true |
| approval_required |
boolean |
否 |
節點修復是否需要人工審批。 |
|
| auto_repair_policy_id |
string |
否 |
自動修復策略 ID。 |
r-xxxxxxxxxx |
| 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 |
否 |
是否允許重新啟動節點,僅當 |
true |
| 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 |
否 |
【該欄位已廢棄】請使用上層的 |
true |
| surge |
integer |
否 |
額外節點數量。與 升級時節點將無法使用,您可以建立額外節點來補償叢集的負載。 說明
建議建立的額外節點不超過目前的節點數。 |
5 |
| surge_percentage |
integer |
否 |
額外節點數的百分比,與 額外節點數 = 額外節點數比例 × 節點數,例如,設定額外節點數比例為 50%,現有的節點數為 6,則產生的額外節點數 = 50% × 6,也就是將產生 3 個額外節點。 |
0 |
| max_unavailable |
integer |
否 |
最大不可用節點數量。 |
1 |
| auto_fault_diagnosis |
boolean |
否 |
是否啟用節點自癒 ECS 故障偵測。 |
|
| drift_enabled |
boolean |
否 |
是否啟用節點輪轉能力。僅智慧託管節點池支援,且預設開啟;普通節點池暫不支援。 |
|
| scaling_group |
object |
否 |
節點池伸縮組設定。 |
|
| vswitch_ids |
array |
否 |
虛擬交換器 ID 清單,取值範圍 [1,8]。 |
|
|
string |
否 |
虛擬交換器 ID。 |
vsw-wz9uwxhawmtzg7u9h**** |
|
| instance_types |
array |
否 |
節點執行個體規格清單,您可以選擇多個執行個體規格作為備選,每個節點建立時,將從第一個規格開始嘗試購買,直到建立成功。最終購買的執行個體規格可能隨庫存變化而不同。 支援的執行個體規格數量範圍:[1,10] |
|
|
string |
否 |
執行個體規格。請參見執行個體規格族。 |
ecs.c6.large |
|
| 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 |
否 |
搶占式執行個體類型,取值:
更多資訊,請參見搶占式執行個體。 |
SpotWithPriceLimit |
| 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_3_x64_20G_alibase_20241218.vhd |
| system_disk_category |
string |
否 |
節點系統磁碟類型,取值:
預設值: |
cloud_efficiency |
| system_disk_categories |
array |
否 |
系統磁碟的多磁碟類型。當無法使用高優先順序的磁碟類型時,自動嘗試下一優先順序的磁碟類型建立系統磁碟。 |
|
|
string |
否 |
節點的多系統磁碟類型。 取值範圍:
|
cloud_essd |
|
| system_disk_size |
integer |
否 |
節點系統磁碟大小,單位為 GiB。 取值範圍:[20,2048]。 該參數的取值必須大於或等於 max{20, ImageSize}。 預設值:max{40, 參數 ImageId 對應的映像大小}。 |
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_provisioned_iops |
integer |
否 |
節點系統磁碟預配置的讀寫 IOPS。 可能值:0~min{50,000, 1000*容量-基準效能}。基準效能=min{1,800+50*容量, 50000}。 當 |
1000 |
| system_disk_bursting_enabled |
boolean |
否 |
節點系統磁碟是否啟用 Burst(效能突發)。取值:
當 |
true |
| data_disks |
array |
否 |
節點資料磁碟設定,取值範圍 [0,10]。最多支援新增 10 塊資料磁碟。 |
|
| data_disk |
否 |
節點資料磁碟設定。 |
||
| disk_init |
array |
否 |
區塊裝置初始化設定。 |
|
|
DiskInit |
否 |
區塊裝置初始化設定。 |
||
| key_pair |
string |
否 |
金鑰對名稱,和 |
pro-nodepool |
| login_password |
string |
否 |
SSH 登入密碼,和 |
Hello1234 |
| internet_charge_type |
string |
否 |
公網 IP 收費類型。取值: |
PayByBandwidth |
| internet_max_bandwidth_out |
integer |
否 |
節點公網 IP 出頻寬最大值,單位為 Mbps(Mega bit per second),取值範圍:[1,100]。 |
5 |
| tags |
array |
否 |
僅為 ECS 執行個體新增標籤。 標籤鍵不可以重複,最大長度為 128 個字元;標籤鍵和標籤值都不能以「aliyun」、「acs:」開頭,或包含「https://」、「http://」。 |
|
| tag |
否 |
ECS 執行個體標籤。 |
||
| desired_size |
integer |
否 |
節點池期望節點數量。 節點池應該維持的總節點數量,建議至少配置 2 個節點,以確保叢集元件正常運行。您可以透過調整期望節點數,達到擴容或縮容節點池的目的。 如無需建立節點,可填寫為 0,後續再手動調整,增加節點數。 |
2 |
| multi_az_policy |
string |
否 |
多可用區伸縮群組 ECS 執行個體擴縮容策略。取值:
預設值: |
BALANCE |
| 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 |
| rds_instances |
array |
否 |
RDS 執行個體清單。 |
|
|
string |
否 |
RDS 執行個體 ID。如果指定了 RDS 執行個體清單,叢集節點 ECS 會自動加入 RDS 存取白名單。 |
rds-xxx |
|
| private_pool_options |
object |
否 |
私有節點池設定。 |
|
| id |
string |
否 |
私有節點池 ID。當 |
eap-bp67acfmxazb4**** |
| match_criteria |
string |
否 |
私有節點池類型,執行個體啟動的私有池容量選項。彈性保障服務或容量預定服務在生效後會產生私有池容量,供執行個體啟動時選擇。取值:
|
Open |
platform
deprecated
|
string |
否 |
【該欄位已廢棄】請使用 |
AliyunLinux |
| instance_patterns |
array |
否 |
執行個體屬性設定。 |
|
| instance_patterns |
否 |
執行個體屬性。 |
||
| deploymentset_id |
string |
否 |
節點池彈出 ECS 所屬的部署集,僅對增量節點生效,存量節點的部署集不會變更。 |
ds-bp1d19mmbsv3jf6xxxxx |
| security_group_ids |
array |
否 |
安全性群組 ID 清單。 |
|
|
string |
否 |
安全性群組 ID。 |
sg-wz9a8g2mt6x5ll****** |
|
| 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**** |
| 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 |
| unschedulable |
boolean |
否 |
擴容後的節點是否不可排程。 |
false |
| user_data |
string |
否 |
執行個體自訂資料。節點加入叢集後,將執行您指定的執行個體自訂資料指令碼。請參見 User-Data 指令碼。 |
IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi |
| cms_enabled |
boolean |
否 |
是否在 ECS 節點上安裝雲端監控,安裝後可以在雲端監控主控台檢視所建立 ECS 執行個體的監控資訊,建議啟用。取值:
預設值: |
true |
| pre_user_data |
string |
否 |
執行個體預先自訂資料。節點加入叢集前,將執行您指定的執行個體預先自訂資料指令碼。請參見 User-Data 指令碼。 |
IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi |
| node_name_mode |
string |
否 |
自訂節點名稱參數。節點名稱由三部分組成:前綴 + 節點 IP + 後綴 前綴和後綴均可由「.」分隔的一個或多個部分構成,每個部分可以使用小寫字母、數字和「-」,節點名稱首尾必須為小寫字母和數字;節點 IP 為完整的節點私有網路 IP 位址; 傳參包含四個部分,由逗號分隔,例如:參數傳入 "customized,aliyun,ip,com" 字串(其中「customized」和「ip」為固定的字串,aliyun 為前綴,com 為後綴),則節點的名稱為:aliyun.192.168.xxx.xxx.com。 |
customized,aliyun,ip,com |
| tee_config |
object |
否 |
加密運算叢集配置。 |
|
| tee_enable |
boolean |
否 |
是否啟用加密運算叢集,取值: |
false |
| update_nodes |
boolean |
否 |
同步更新節點標籤及污點。 |
true |
| concurrency |
boolean |
否 |
是否並行。 |
true |
| eflo_node_group |
object |
否 |
靈駿節點池配置。(不生效) |
|
| auto_attach_enabled |
string |
否 |
是否開啟靈駿節點池自動新增(不生效)。 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回主體資料。 |
||
| task_id |
string |
任務 ID。 |
T-5fd211e924e1d00787000293 |
| nodepool_id |
string |
節點池 ID。 |
np737c3ac1ac684703b9e10673aa2c**** |
| request_id |
string |
請求 ID。 |
687C5BAA-D103-4993-884B-C35E4314**** |
樣本
正常返回樣本
JSON格式
{
"task_id": "T-5fd211e924e1d00787000293",
"nodepool_id": "np737c3ac1ac684703b9e10673aa2c****",
"request_id": "687C5BAA-D103-4993-884B-C35E4314****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。