通用資料結構 -

addon

叢集組件配置。

參數名稱	類型	樣本值	描述
name	String	nginx-ingress-controller	組件名稱。
config	String	{\"IngressSlbNetworkType\":\"internet\"}	組件配置。
disabled	Boolean	false	是否禁止預設安裝，叢集建立時除了安裝必要元件外，還會額外安裝一些日誌組件等，您可以禁止這些預設行為，後續通過安裝組件的API進行安裝或者通過控制台安裝。取值： `true`：禁止預設安裝。 `false`：允許預設安裝。

參數名稱

類型

樣本值

描述

name

String

nginx-ingress-controller

組件名稱。

config

String

{\"IngressSlbNetworkType\":\"internet\"}

組件配置。

disabled

Boolean

false

是否禁止預設安裝，叢集建立時除了安裝必要元件外，還會額外安裝一些日誌組件等，您可以禁止這些預設行為，後續通過安裝組件的API進行安裝或者通過控制台安裝。取值：

true：禁止預設安裝。
false：允許預設安裝。

data_disk

節點資料盤配置。

參數名稱	類型	樣本值	描述
category	String	cloud_ssd	資料盤類型。取值： `cloud`：普通雲端硬碟。 `cloud_efficiency`：高效雲端硬碟。 `cloud_ssd`：SSD雲端硬碟。 `cloud_essd`：ESSD雲端硬碟。 `cloud_auto`：ESSD AutoPL雲端硬碟。預設值：`cloud_efficiency`。
size	Long	40	資料盤大小，單位為GiB。取值範圍：[40,32768]。預設值：`120`。
encrypted	String	true	是否對資料盤加密。取值： `true`：對資料盤加密。 `false`：不對資料盤加密。預設值：`false`。
auto_snapshot_policy_id	String	sp-2zej1nogjvovnz4z****	選擇自動快照策略ID，雲端硬碟會按照快照策略自動備份。預設值：空，不自動備份。
performance_level	String	PL1	節點資料盤磁碟效能等級，僅對ESSD磁碟生效。磁碟效能等級和磁碟大小有關。更多資訊，請參見ESSD雲端硬碟。
provisioned_iops	Long	1000	資料盤預配置的讀寫IOPS。可能值：0~min{50,000, 1000容量-基準效能}。基準效能=min{1,800+50容量, 50000}。當`DiskCategory`取值為`cloud_auto`時才支援設定該參數。更多資訊，請參見ESSD AutoPL雲端硬碟。
bursting_enabled	Boolean	true	資料盤是否開啟Burst（效能突發）。取值： `true`：是。 `false`：否。當`DiskCategory`取值為`cloud_auto`時才支援設定該參數。更多資訊，請參見ESSD AutoPL雲端硬碟。

maintenance_window

叢集維護視窗。

參數名稱	類型	樣本值	描述
enable	Boolean	false	是否開啟維護視窗。取值： `true`：開啟維護視窗。 `false`：不開啟維護視窗。預設值：`false`。
maintenance_time	String	03:00:00Z	維護起始時間。Golang標準時間格式，例如15:04:05Z。
duration	String	3h	維護時間長度。取值範圍[1,24]，單位為小時。預設值：3h。
weekly_period	String	Monday,Thursday	維護周期，多個值用英文逗號（,）分隔。取值：{Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday} 預設值：`Thursday`。

nodepool

節點池。

參數名稱	類型	樣本值	描述
auto_scaling	Object		自動調整節點池配置。
enable	Boolean	true	是否啟用自動調整。 `true`：開啟節點池自動調整功能。 `false`：不開啟自動調整，當取值為false時，`auto_scaling`內的其他配置參數將不生效。預設值：`false`。
max_instances	Long	10	自動調整組最大執行個體數。
min_instances	Long	0	自動調整組最小執行個體數。
type	String	cpu	自動調整類型，按照自動調整執行個體類型劃分。取值： `cpu`：普通執行個體型。 `gpu`：GPU執行個體型。 `gpushare`：GPU共用型。 `spot`：搶佔式執行個體型。預設值：`cpu`。
is_bond_eip	Boolean	true	【該欄位已廢棄】是否綁定EIP，取值： `true`：綁定EIP。 `false`：不綁定EIP。預設值：`false`。
eip_internet_charge_type	String	PayByBandwidth	【該欄位已廢棄】 EIP計費類型，取值： `PayByBandwidth`：按固定頻寬計費。 `PayByTraffic`：按使用流量計費。預設值：PayByBandwidth。
eip_bandwidth	Long	5	【該欄位已廢棄】 EIP頻寬峰值。單位：Mbps。
kubernetes_config	Object		叢集相關配置。
cms_enabled	Boolean	true	是否在ECS節點上安裝CloudMonitor，安裝後可以在CloudMonitor控制台查看所建立ECS執行個體的監控資訊，推薦開啟。取值： `true`：在ECS節點上安裝CloudMonitor。 `false`：不在ECS節點上安裝CloudMonitor。預設值：`false`。
cpu_policy	String	none	節點CPU管理原則。當叢集版本在1.12.6及以上時支援以下兩種策略： `static`：允許為節點上具有某些資源特徵Pod增強其CPU親和性和獨佔性。 `none`：表示啟用現有的預設CPU親和性方案。預設值：`none`。
labels	Array of tag		節點標籤，為Kubernetes叢集節點添加標籤。
runtime	String	containerd	容器運行時。取值： `containerd`：推薦使用，支援所有叢集版本。 `Sandboxed-Container.runv`：安全沙箱容器，提供更高的隔離性，支援1.24版本及以下叢集。 `docker`：支援1.22版本及以下叢集。預設值：`containerd`
runtime_version	String	1.6.20	容器運行時版本。
taints	Array of taint		汙點配置。
user_data	String	MXM=	節點自訂資料。
node_name_mode	String	customized,aliyun,ip,com	節點名稱由三部分組成：首碼 + 節點 IP + 尾碼：首碼和尾碼均可由“.”分隔的一個或多個部分構成，每個部分可以使用小寫字母、數字和“-”，節點名稱首尾必須為小寫字母和數字；節點 IP為完整的節點私網 IP 位址；傳參包含四個部分，由逗號分隔，例如：參數傳入"customized,aliyun,ip,com"字串（其中“customized”和"ip"為固定的字串，aliyun為首碼，com為尾碼），則節點的名稱為：aliyun.192.168.xxx.xxx.com。
nodepool_info	Object		節點池配置。
name	String	np-test	節點池名稱。
resource_group_id	String	rg-acfmyvw3wjm****	節點池所在資源ID。
type	String	ess	節點池類型，取值範圍： `ess`：節點池。 `edge`：邊緣節點池。
scaling_group	Object		節點池擴容組配置。
auto_renew	Boolean	false	節點池是否開啟自動續約，當`instance_charge_type`取值為`PrePaid`時才生效，取值： `true`：自動續約。 `false`：不自動續約。預設值：`true`。
auto_renew_period	Long	0	節點池自動續約周期。當`instance_charge_type`取值為`PrePaid`時才生效，且為必選值。當`PeriodUnit=Month`時，取值範圍：{1, 2, 3, 6, 12}。預設值：1。
data_disks	Array of data_disk		節點池節點資料盤配置。
image_id	String	aliyun_2_1903_x64_20G_alibase_20200904.vhd	自訂鏡像ID，預設使用系統提供的鏡像。
instance_charge_type	String	PostPaid	節點池節點付費類型，取值： `PrePaid`：預付費。 `PostPaid`：隨用隨付。預設值：`PostPaid`。
instance_types	Array of String	ecs.n1.medium	執行個體規格。
key_pair	String	np-key	金鑰組名稱，和`login_password`二選一。說明如果建立託管節點池，則只支援`key_pair`。
login_password	String	Hello1234	SSH登入密碼，和`key_pair`二選一。密碼規則為8~30個字元，且至少同時包含三項（大小寫字母、數字和特殊符號）。
period	Long	0	節點池節點訂用帳戶時間長度，當`instance_charge_type`取值為`PrePaid`時才生效且為必選值，取值範圍：`period_unit`取值為Month時，`period`取值範圍：{ 1, 2, 3, 6, 12}。預設值：1。
period_unit	String	Month	節點池節點付費周期，當`instance_charge_type`取值為`PrePaid`時需要指定周期。 `Month`：目前只支援以月為單位。
platform	String	AliyunLinux	作業系統發行版。取值： `CentOS` `AliyunLinux` `Windows` `WindowsCore` 預設值：`AliyunLinux`。
rds_instances	Array of String	rm-2zey3t89t6280****	RDS執行個體ID。
spot_strategy	String	NoSpot	搶佔式執行個體類型，取值： NoSpot：非搶佔式執行個體。 SpotWithPriceLimit：設定搶佔執行個體價格上限。 SpotAsPriceGo：系統自動出價，跟隨當前市場實際價格。更多資訊，請參見搶佔式執行個體。
spot_price_limit	Array		當前單台搶佔式執行個體規格市場價格區間配置。
instance_type	String	ecs.c6.large	搶佔式執行個體規格。
price_limit	String	0.39	單台執行個體上限價格。
scaling_policy	String	release	伸縮組模式，取值： `release`：標準模式，根據申請資源值的使用量，通過建立、釋放ECS的方式進行伸縮。 `recycle`：極速模式，通過建立、停機、啟動的方式進行伸縮，提高再次伸縮的速度（停機時計算資源不收費，只收取儲存費用，本地碟機型除外）。預設值：`release`。
security_group_id	String	sg-2zeihch86ooz9io4****	節點池安全性群組ID，與`security_group_ids`二選一，推薦使用`security_group_ids`。
security_group_ids	Array of String	sg-2zeihch86ooz9io4****	安全性群組ID。
system_disk_category	String	cloud_efficiency	節點系統硬碟類型，取值： `cloud_efficiency`：高效雲端硬碟。 `cloud_ssd`：SSD雲端硬碟。 `cloud_essd`：ESSD雲端硬碟。 `cloud_auto`：ESSD AutoPL雲端硬碟。預設值：`cloud_efficiency`。
system_disk_size	Long	120	節點系統硬碟大小，單位：GiB。取值範圍：[40,500]。
system_disk_performance_level	String	PL1	節點系統硬碟磁碟效能，只對ESSD磁碟生效。 PL0：並發極限I/O效能中等，讀寫時延較為穩定。 PL1：並發極限I/O效能中等，讀寫時延較為穩定。 PL2：並發極限I/O效能較高，讀寫時延穩定。 PL3：並發極限I/O效能極高，讀寫時延極穩定。
system_disk_provisioned_iops	Long	1000	節點系統硬碟預配置的讀寫IOPS。可能值：0~min{50,000, 1000容量-基準效能}。基準效能=min{1,800+50容量, 50000}。當`SystemDiskCategory`為`cloud_auto`時才支援設定該參數。更多資訊，請參見ESSD AutoPL雲端硬碟。
system_disk_bursting_enabled	Boolean	true	節點系統硬碟是否開啟Burst（效能突發）。取值： true：是。 false：否。當`SystemDiskCategory`取值為`cloud_auto`時才支援設定該參數。更多資訊，請參見ESSD AutoPL雲端硬碟。
tags	Array		僅為ECS執行個體添加標籤。標籤鍵不可以重複，最大長度為128個字元；標籤鍵和標籤值都不能以“aliyun”、“acs:”開頭，或包含“https://”、“http://”。
key	String	key	標籤的名稱。
value	String	value	標籤值。
vswitch_ids	Array of String	vsw-2ze0fmpbwo140ahni****	虛擬交換器ID。
multi_az_policy	String	COST_OPTIMIZED	多可用性區域伸縮組ECS執行個體擴縮容策略。取值： `PRIORITY`：根據您定義的虛擬交換器（VSwitchIds.N）擴縮容。當優先順序較高的虛擬交換器所在可用性區域無法建立ECS執行個體時，自動使用下一優先順序的虛擬交換器建立ECS執行個體。 `COST_OPTIMIZED`：按vCPU單價從低到高進行嘗試建立。當伸縮配置設定了搶佔式計費方式的多執行個體規格時，優先建立對應搶佔式執行個體。您可以繼續通過`CompensateWithOnDemand`參數指定當搶佔式執行個體由於庫存等原因無法建立時，是否自動嘗試以隨用隨付的方式建立。說明 `COST_OPTIMIZED`僅在伸縮配置設定了多執行個體規格或者選用了搶佔式執行個體的情況下生效。 `BALANCE`：在伸縮組指定的多可用性區域之間均勻分配ECS執行個體。如果由於庫存不足等原因可用性區域之間變得不平衡，您可以通過API RebalanceInstances平衡資源。更多資訊，請參見RebalanceInstances。預設值：`PRIORITY`。
on_demand_base_capacity	Long	0	伸縮組所需要按量執行個體個數的最小值，取值範圍：[0,1000]。當按量執行個體個數少於該值時，將優先建立按量執行個體。
on_demand_percentage_above_base_capacity	Long	20	伸縮組滿足最小按量執行個體數（`on_demand_base_capacity`）要求後，超出的執行個體中按量執行個體應占的比例。取值範圍：[0,100]。
spot_instance_pools	Long	5	指定可用執行個體規格的個數，伸縮組將按成本最低的多個規格均衡建立搶佔式執行個體。取值範圍：[1,10]。
spot_instance_remedy	Boolean	false	是否開啟補齊搶佔式執行個體。開啟後，當收到搶佔式執行個體將被回收的系統訊息時，伸縮組將嘗試建立新的執行個體，替換掉將被回收的搶佔式執行個體。取值： `true`：開啟補齊搶佔式執行個體。 `false`：不開啟補齊搶佔式執行個體。
compensate_with_on_demand	Boolean	true	當`multi_az_policy`取值為`COST_OPTIMIZED`時，如果因價格、庫存等原因無法建立足夠的搶佔式執行個體，是否允許自動嘗試建立按量執行個體滿足ECS執行個體數量要求。取值： `true`：允許自動嘗試建立按量執行個體滿足ECS執行個體數量要求。 `false`：不允許自動嘗試建立按量執行個體滿足ECS執行個體數量要求。
internet_charge_type	String	PayByBandwidth	公網IP收費類型。取值： `PayByBandwidth`：按固定頻寬計費。 `PayByTraffic`：按使用流量計費。
internet_max_bandwidth_out	Long	10	節點公網IP出頻寬最大值，單位為Mbps（Mega bit per second），取值範圍：[1,100]
image_type	String	AliyunLinux	作業系統鏡像類型，和platform參數二選一，取值範圍： `AliyunLinux`：Alinux2鏡像。 `AliyunLinux3`：Alinux3鏡像。 `AliyunLinux3Arm64`：Alinux3鏡像ARM版。 `AliyunLinuxUEFI`：Alinux2鏡像UEFI版。 `CentOS`：CentOS鏡像。 `Windows`：Windows鏡像。 `WindowsCore`：WindowsCore鏡像。 `ContainerOS`：容器最佳化鏡像。
deploymentset_id	String	ds-bp1d19mmbsv3jf6xxxxx	部署集ID。
desired_size	Long	2	節點池期望節點數量。
private_pool_options	Object		私人節點池配置。
id	String	eap-bp67acfmxazb4****	私人節點池ID。
match_criteria	String	Open	私人節點池類型，執行個體啟動的私人池容量選項。彈性保障服務或容量預定服務在生效後會產生私人池容量，供執行個體啟動時選擇。取值： `Open`：開放模式。將自動匹配開放類型的私人池容量。如果沒有合格私人池容量，則使用公用池資源啟動。 `Target`：指定模式。使用指定的私人池容量啟動執行個體，如果該私人池容量不可用，則執行個體會啟動失敗。 `None`：不使用模式。執行個體啟動將不使用私人池容量。
tee_config	Object		加密計算節點池配置。
tee_enable	Boolean	false	是否為加密計算節點池。
management	Object		託管節點池配置。
enable	Boolean	false	是否開啟託管版節點池，取值： `true`：開啟託管節點池。 `false`：不開啟託管節點池，只有當`enable=true`時，其他相關配置才生效。
auto_repair	Boolean	false	自動修複，僅當`enable=true`時生效。 `true`：自動修複。 `false`：不自動修複。
upgrade_config	Object		自動升級配置，僅當`enable=true`時生效。
auto_upgrade	Boolean	false	是否啟用自動升級，取值： `true`：啟用自動升級。 `false`：不啟用自動升級。
surge	Long	0	額外節點數量。
surge_percentage	Long	0	額外節點比例，和`surge`二選一。
max_unavailable	Long	0	最大不可用節點數量，取值範圍：[1,1000]。預設值：1。
count	Long	1	【該欄位已廢棄，請使用desired_size代替】節點池節點數量。
interconnect_mode	String	basic	邊緣節點池的網路類型，該值只對`type`為`edge`類型的節點池有意義，取值範圍： `basic`：基礎型。 `improved`：增強型。 `private`: 專用型。1.22及以上版本支援。
interconnect_config	Object		【該欄位已廢棄】邊緣節點池配置。
cen_id	String	cen-ey9k9nfhz0f*******	【該欄位已廢棄】邊緣增強型節點池綁定的雲企業網執行個體ID(CENID)。
ccn_id	String	ccn-qm5i0i0q9yi*******	【該欄位已廢棄】邊緣增強型節點池綁定的雲串連網執行個體ID(CCNID)。
ccn_region_id	String	cn-shanghai	【該欄位已廢棄】邊緣增強型節點池綁定的雲串連網執行個體所屬的地區。
bandwidth	Long	10	【該欄位已廢棄】邊緣增強型節點池的網路頻寬，單位：Mbps。
improved_period	String	1	【該欄位已廢棄】邊緣增強型節點池的購買時間長度，單位：月。
max_nodes	Long	10	邊緣節點池允許容納的最大節點數量，該參數大於等於0。0表示無額外限制（僅受限於叢集整體可以容納的節點數，節點池本身無額外限制）。邊緣節點池該參數值往往大於0；ess類型節點池和預設的edge類型節點池該參數值為0。

runtime

容器引擎。

參數名稱	類型	樣本值	描述
name	String	containerd	容器運行時名稱，ACK支援以下三種容器運行時。 `containerd`：推薦使用，支援所有叢集版本。 `Sandboxed-Container.runv`：安全沙箱容器，提供更高的隔離性，支援1.24版本及以下叢集。 `docker`：支援1.22版本及以下叢集。預設值：`containerd`
version	String	1.6.20	容器運行時版本，預設為最新版。關於安全沙箱運行時的變更詳情，請參見安全沙箱運行時變更記錄。

參數名稱

類型

樣本值

描述

name

String

containerd

容器運行時名稱，ACK支援以下三種容器運行時。

containerd：推薦使用，支援所有叢集版本。
Sandboxed-Container.runv：安全沙箱容器，提供更高的隔離性，支援1.24版本及以下叢集。
docker：支援1.22版本及以下叢集。

預設值：containerd

version

String

1.6.20

容器運行時版本，預設為最新版。

關於安全沙箱運行時的變更詳情，請參見安全沙箱運行時變更記錄。

tag

標籤配置。

參數名稱	類型	樣本值	描述
key	String	env	標籤`key`值。
value	String	prod	標籤`value`值。

taint

節點汙點配置。

參數名稱	類型	樣本值	描述
key	String	key	汙點`key`值。
value	String	value	汙點`value`值。
effect	String	NoSchedule	調度策略。取值： `NoSchedule`：不能容忍，但僅影響調度過程，已被調度的Pod不受影響，僅對新增加的Pod生效。 `NoExecute`：不能容忍，當汙點變動時，Pod對象會被驅逐。 `PreferNoSchedule`：柔性約束，節點現存Pod不受影響。盡量不去滿足不合要求的Pod調度到節點上。預設策略：`NoSchedule`。

參數名稱

類型

樣本值

描述

key

String

key

汙點key值。

value

String

value

汙點value值。

effect

String

NoSchedule

調度策略。取值：

NoSchedule：不能容忍，但僅影響調度過程，已被調度的Pod不受影響，僅對新增加的Pod生效。
NoExecute：不能容忍，當汙點變動時，Pod對象會被驅逐。
PreferNoSchedule：柔性約束，節點現存Pod不受影響。盡量不去滿足不合要求的Pod調度到節點上。

預設策略：NoSchedule。