建立一個彈性供應群組。
介面說明
彈性供應是一個使用搶占式執行個體和按量付費執行個體快速部署執行個體叢集的方案,支援一鍵部署跨計費方式、跨可用區、跨執行個體規格族的執行個體叢集。更多資訊,請參見使用彈性供應群組 API 批次建立 ECS 執行個體。
彈性供應以供應群組為載體調度和維護運算資源,您可以透過彈性供應群組穩定提供運算力,緩解搶占式執行個體的回收機制帶來的不穩定因素。
彈性供應為免費功能,但是您需要為透過彈性供應群組建立出的執行個體資源付費。更多資訊,請參見搶占式執行個體計費和按量付費。
當您同時指定啟動範本(
LaunchTemplateId)與啟動設定資訊(LaunchConfiguration.*)時,系統優先使用啟動範本。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:CreateAutoProvisioningGroup |
create |
*全部資源。
|
無 |
|
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
彈性供應群組所在地域的 ID,您可以呼叫 DescribeRegions 檢視最新的阿里雲地域清單。 |
cn-hangzhou |
| ResourceGroupId |
string |
否 |
彈性供應群組所在的企業資源群組 ID。 |
rg-bp67acfmxazb4p**** |
| AutoProvisioningGroupName |
string |
否 |
彈性供應群組的名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以 |
apg-test |
| AutoProvisioningGroupType |
string |
否 |
彈性供應群組的交付類型。取值範圍:
預設值:maintain。 |
maintain |
| SpotAllocationStrategy |
string |
否 |
建立搶佔式執行個體的策略。取值範圍:
預設值:lowest-price。 |
diversified |
| SpotInstanceInterruptionBehavior |
string |
否 |
競價執行個體中斷時的行為。取值範圍:
預設值:terminate。 |
terminate |
| SpotInstancePoolsToUseCount |
integer |
否 |
在 取值範圍:低於 |
2 |
| PayAsYouGoAllocationStrategy |
string |
否 |
建立隨收隨付執行個體的策略。取值範圍:
預設值:lowest-price。 |
prioritized |
| ExcessCapacityTerminationPolicy |
string |
否 |
彈性供應群組即時容量超過目標容量並觸發縮容時,是否釋放縮容的執行個體。取值範圍:
預設值:no-termination。 |
termination |
| ValidFrom |
string |
否 |
彈性供應群組的啟動時間,和 按照ISO 8601標準表示,並使用 UTC+0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 預設值:該介面立即生效的時間戳記。 |
2019-04-01T15:10:20Z |
| ValidUntil |
string |
否 |
彈性供應群組的到期時間,和 按照ISO 8601標準表示,並使用 UTC+0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 預設值:2099-12-31T23:59:59Z。 |
2019-06-01T15:10:20Z |
| TerminateInstancesWithExpiration |
boolean |
否 |
彈性供應群組到期時,是否釋放群組內執行個體。取值範圍:
預設值:false。 |
true |
| TerminateInstances |
boolean |
否 |
刪除彈性供應群組時,是否釋放群組內執行個體。取值範圍:
預設值:false。 |
true |
| MaxSpotPrice |
number |
否 |
彈性供應群組內搶佔式執行個體的最高價格。 說明
同時設定了 |
2 |
| TotalTargetCapacity |
string |
是 |
彈性供應群組的目標總容量。取值範圍:正整數。 總容量必須大於等於 |
60 |
| PayAsYouGoTargetCapacity |
string |
否 |
彈性供應群組內,隨收隨付執行個體的目標容量。取值範圍:小於等於 |
30 |
| SpotTargetCapacity |
string |
否 |
彈性供應群組內,搶佔式執行個體的目標容量。取值範圍:小於等於 |
20 |
| DefaultTargetCapacityType |
string |
否 |
預設值:Spot。 |
Spot |
| LaunchTemplateId |
string |
否 |
彈性供應群組關聯的執行個體啟動範本的 ID,您可以呼叫 DescribeLaunchTemplates 查詢可用的執行個體啟動範本。同時指定啟動範本與啟動設定資訊( |
lt-bp1fgzds4bdogu03**** |
| LaunchTemplateVersion |
string |
否 |
彈性供應群組關聯的執行個體啟動範本的版本,您可以呼叫 DescribeLaunchTemplateVersions 查詢可用的執行個體啟動範本版本。 預設值:啟動範本的預設版本。 |
1 |
| Description |
string |
否 |
彈性供應群組的描述資訊。 |
testDescription |
| ClientToken |
string |
否 |
保證請求冪等性。從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元,且不能超過 64 個字元。更多資訊,請參見如何保證冪等性。 |
0c593ea1-3bea-11e9-b96b-88e9fe637760 |
| LaunchConfiguration.ImageId |
string |
否 |
映像 ID。啟動執行個體時選擇的映像資源,您可以呼叫 DescribeImages 查詢可以使用的映像資源。同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
m-bp1g7004ksh0oeuc**** |
| LaunchConfiguration.SecurityGroupId |
string |
否 |
執行個體所屬的安全性群組 ID。同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
sg-bp15ed6xe1yxeycg**** |
| LaunchConfiguration.IoOptimized |
string |
否 |
是否為 I/O 最佳化執行個體。取值範圍:
已停售的執行個體規格執行個體預設值是 none,其他執行個體規格預設值是 optimized。 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
optimized |
| LaunchConfiguration.InternetChargeType |
string |
否 |
網路計費類型。取值範圍:
說明
按使用流量計費模式下的出入頻寬峰值都是頻寬上限,不作為業務承諾指標。當出現資源爭搶時,頻寬峰值可能會受到限制。如果您的業務需要有頻寬的保障,請使用按固定頻寬計費模式。 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
PayByTraffic |
| LaunchConfiguration.InternetMaxBandwidthIn |
integer |
否 |
公網入頻寬最大值,單位為 Mbit/s。取值範圍:
同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
10 |
| LaunchConfiguration.InternetMaxBandwidthOut |
integer |
否 |
公網出頻寬最大值,單位為 Mbit/s。取值範圍:0~100。 預設值:0。 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
10 |
| LaunchConfiguration.InstanceName |
string |
否 |
執行個體名稱。長度為 2~128 個字元,必須以大小寫字母或中文開頭,不能以 預設值:執行個體的 建立多台 ECS 執行個體時,您可以批次設定有序的執行個體名稱。具體操作,請參見批次設定有序的執行個體名稱或主機名稱。 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
k8s-node-[1,4]-alibabacloud |
| LaunchConfiguration.HostName |
string |
否 |
執行個體主機名稱。限制說明如下:
|
k8s-node-[1,4]-ecshost |
| LaunchConfiguration.InstanceDescription |
string |
否 |
執行個體描述。長度為 2~256 個英文或中文字元,不能以 |
Instance_Description |
| LaunchConfiguration.KeyPairName |
string |
否 |
金鑰對名稱。
同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
KeyPair_Name |
| LaunchConfiguration.RamRoleName |
string |
否 |
執行個體 RAM 角色名稱。您可以使用 RAM API ListRoles 查詢您已建立的執行個體 RAM 角色。同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
RAM_Name |
| LaunchConfiguration.SecurityEnhancementStrategy |
string |
否 |
是否開啟安全性加固。取值範圍:
同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
Active |
| LaunchConfiguration.UserData |
string |
否 |
執行個體自訂資料。需要以 Base64 方式編碼,原始資料最多為 32 KB。同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
ZWNobyBoZWxsbyBlY3Mh |
| LaunchConfiguration.SystemDiskCategory |
string |
否 |
系統磁碟的雲端硬碟種類。取值範圍:
已停售的執行個體規格且非 I/O 最佳化執行個體預設值為 cloud,否則預設值為 cloud_efficiency。 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
cloud_ssd |
| LaunchConfiguration.SystemDiskSize |
integer |
否 |
系統磁碟大小。單位為 GiB,取值範圍:20~500。該參數的取值必須大於或者等於 max{20, LaunchConfiguration.ImageId 對應的映像大小}。 預設值:max{40, 參數 LaunchConfiguration.ImageId 對應的映像大小}。 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
40 |
| LaunchConfiguration.SystemDiskName |
string |
否 |
系統磁碟名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以 預設值:空。 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
cloud_ssdSystem |
| LaunchConfiguration.SystemDiskDescription |
string |
否 |
系統磁碟的描述。長度為 2~256 個英文或中文字元,不能以 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
SystemDisk_Description |
| LaunchConfiguration.SystemDiskPerformanceLevel |
string |
否 |
建立 ESSD 雲端硬碟作為系統磁碟使用時,設定雲端硬碟的效能等級。取值範圍:
有關如何選擇 ESSD 效能等級,請參見 ESSD 雲端硬碟。 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
PL0 |
| LaunchConfiguration.PasswordInherit |
boolean |
否 |
是否使用映像預設的密碼。取值範圍:
同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
true |
| LaunchConfiguration.ResourceGroupId |
string |
否 |
執行個體所在的企業資源群組 ID。同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
rg-bp67acfmxazb4p**** |
| LaunchConfiguration.CreditSpecification |
string |
否 |
設定突增效能執行個體的運作模式。取值範圍:
預設值:無。 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
Standard |
| LaunchConfiguration.Password |
string |
否 |
執行個體的密碼。長度為 8 至 30 個字元,必須同時包含大小寫英文字母、數字和特殊符號中的三類字元。特殊符號可以是:
其中,Windows 執行個體不能以正斜線(/)為密碼首字元。 同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
EcsV587! |
| LaunchConfiguration.DeploymentSetId |
string |
否 |
部署集 ID。 |
ds-bp1frxuzdg87zh4p**** |
| LaunchTemplateConfig |
array<object> |
否 |
擴充啟動範本清單。 |
|
|
object |
否 |
擴充啟動範本資訊。 |
||
| VSwitchId |
string |
否 |
擴充啟動範本中,ECS 執行個體加入的虛擬交換器的 ID。擴充範本中啟動的 ECS 執行個體的可用區由虛擬交換器決定。 說明
設定 |
vsw-sn5bsitu4lfzgc5o7**** |
| MaxPrice |
number |
否 |
擴充啟動範本中,搶佔式執行個體的價格上限。 說明
設定 |
3 |
| Priority |
integer |
否 |
擴充啟動範本的優先順序,取值為 0 時優先順序最高。取值範圍:0 ~ +∞。 |
1 |
| InstanceType |
string |
否 |
擴充啟動範本對應的執行個體規格,N 的取值範圍:1~20。取值範圍:請參見執行個體規格族。 |
ecs.g5.large |
| WeightedCapacity |
number |
否 |
擴充啟動範本中,執行個體規格的權重。取值越高,單台執行個體滿足運算力需求的能力越大,所需的執行個體數量越小。取值範圍:大於 0。 您可以根據指定執行個體規格的運算力和叢集單節點最低運算力得出權重值。假設單節點最低運算力為 8 vCPU、60 GiB,則:
|
2 |
| MaxQuantity |
integer |
否 |
說明
該參數正在邀測中,暫不支援使用。 |
false |
| Cores |
array |
否 |
執行個體規格的 vCPU 核心數目清單。 |
|
|
integer |
否 |
執行個體規格的 vCPU 核心數目,用於篩選符合要求的執行個體規格範圍。更多資訊,請參見執行個體規格族。N 的取值範圍:1~10。 |
2 |
|
| Memories |
array |
否 |
執行個體規格的記憶體大小清單。 |
|
|
number |
否 |
執行個體規格的記憶體大小,單位為 GiB,用於篩選符合要求的執行個體規格範圍。更多資訊,請參見執行個體規格族。N 的取值範圍:1~10。 |
4 |
|
| InstanceFamilyLevel |
string |
否 |
執行個體規格族層級,用於篩選符合要求的執行個體規格範圍。取值範圍:
N 的取值範圍:1~10。 |
EnterpriseLevel |
| ExcludedInstanceTypes |
array |
否 |
需要排除的執行個體規格清單。 |
|
|
string |
否 |
需要排除的執行個體規格。透過使用萬用字元(*)可以排除單個規格或者整個規格族。例如:
|
ecs.n1.small/ecs.n1.*/*7* |
|
| Architectures |
array |
否 |
執行個體規格所屬的架構類型清單。 |
|
|
string |
否 |
執行個體規格所屬的架構類型。取值範圍:
預設值:包含所有架構類型。 |
X86 |
|
| BurstablePerformance |
string |
否 |
是否為效能突增執行個體規格。取值範圍:
預設值:Include。 |
Include |
| ImageId |
string |
否 |
映像 ID,您可以透過該參數設定目前資源集區使用的映像,如果沒有設定則預設使用 |
aliyun_3_x64_20G_alibase_20210425.vhd |
| LaunchConfiguration.DataDisk |
array<object> |
否 |
擴充啟動範本雲端硬碟配置清單。 |
|
|
object |
否 |
擴充啟動範本雲端硬碟配置資訊。 |
||
| PerformanceLevel |
string |
否 |
建立 ESSD 雲端硬碟作為資料磁碟使用時,設定雲端硬碟的效能等級。N 的取值必須和
有關如何選擇 ESSD 效能等級,請參閱 ESSD 雲端硬碟。 同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
PL1 |
| KmsKeyId |
string |
否 |
資料磁碟對應的 KMS 金鑰 ID。同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| Description |
string |
否 |
資料磁碟的描述。長度為 2~256 個英文或中文字元,不能以 |
DataDisk_Description |
| SnapshotId |
string |
否 |
建立資料磁碟 N 使用的快照。N 的取值範圍為 1~16。 指定該參數後,參數 同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
s-bp17441ohwka0yuh**** |
| Size |
integer |
否 |
第 N 個資料磁碟的容量大小,N 的取值範圍為 1~16,單位為 GiB。取值範圍:
說明
該參數的取值必須大於等於參數 同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
20 |
| Device |
string |
否 |
資料磁碟的掛載點。同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
/dev/vd1 |
| DiskName |
string |
否 |
資料磁碟名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以 預設值:空。 同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
cloud_ssdData |
| Category |
string |
否 |
資料磁碟 N 的雲端硬碟類型。N 的取值範圍為 1~16。取值範圍:
對於 I/O 優化執行個體,預設值為 cloud_efficiency。對於非 I/O 優化執行個體,預設值為 cloud。 同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
cloud_ssd |
| DeleteWithInstance |
boolean |
否 |
資料磁碟是否隨執行個體釋放。取值範圍:
預設值:true。 同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
true |
| Encrypted |
boolean |
否 |
資料磁碟 N 是否加密。取值範圍:
預設值:false。 同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
false |
| EncryptAlgorithm |
string |
否 |
說明
該參數暫未開放使用。 |
null |
| ProvisionedIops |
integer |
否 |
ESSD AutoPL 雲端硬碟預先配置的讀寫 IOPS。可能值:0~min{50,000, 1000*容量-基準效能}。 基準效能=min{1,800+50*容量, 50000}。 說明
當 DiskCategory 取值為 cloud_auto 時才支援設定該參數。更多資訊,請參閱ESSD AutoPL 雲端硬碟。 |
40000 |
| BurstingEnabled |
boolean |
否 |
是否開啟 Burst(效能突增)。取值範圍:
說明
當 DiskCategory 取值為 cloud_auto 時才支援設定該參數。更多資訊,請參閱ESSD AutoPL 雲端硬碟。 |
false |
| AutoSnapshotPolicyId |
string |
否 |
資料磁碟採用的自動快照原則 ID。 當您設定該參數後,需要注意:
|
sp-bp67acfmxazb4p**** |
| LaunchConfiguration.Tag |
array<object> |
否 |
擴充啟動範本標籤清單。 |
|
|
object |
否 |
擴充啟動範本標籤資訊。 |
||
| Key |
string |
否 |
執行個體的標籤鍵。N 的取值範圍:1~20。一旦傳入該值,則不允許為空字串。最多支援 128 個字元,不能以 aliyun 和 acs:開頭,不能包含 |
TestKey |
| Value |
string |
否 |
執行個體的標籤值。N 的取值範圍:1~20。一旦傳入該值,可以為空字串。最多支援 128 個字元,不能以 acs:開頭,不能包含 |
TestValue |
| SystemDiskConfig |
array<object> |
否 |
執行個體系統磁碟資訊清單。 |
|
|
object |
否 |
執行個體系統磁碟資訊。 |
||
| DiskCategory |
string |
否 |
執行個體系統磁碟類型。您可透過該參數指定多種候選磁碟類型,指定順序作為各磁碟類型的優先順序,當某一種磁碟不可用時,自動更換磁碟類型。取值範圍:
|
cloud_ssd |
| DataDiskConfig |
array<object> |
否 |
執行個體資料磁碟資訊清單。 |
|
|
object |
否 |
執行個體資料磁碟資訊。 |
||
| DiskCategory |
string |
否 |
執行個體資料磁碟類型。您可透過該參數指定多種候選磁碟類型,指定順序作為各磁碟類型的優先順序,當某一種磁碟不可用時,自動更換磁碟類型。取值範圍:
|
cloud_efficiency |
| LaunchConfiguration.HostNames |
array |
否 |
為一台或多台執行個體指定不同的主機名稱清單。限制說明如下:
|
ecs-host-01 |
|
string |
否 |
主機名稱。限制說明如下:
|
ecs-host-01 |
|
| MinTargetCapacity |
string |
否 |
彈性供應群組的目標最小容量。取值範圍:正整數。 當您設定該參數後,需要注意:
|
20 |
| LaunchConfiguration.SecurityGroupIds |
array |
否 |
執行個體所屬的安全性群組清單。 |
|
|
string |
否 |
執行個體所屬的安全性群組 ID。同時指定啟動範本與啟動設定資訊時,優先使用啟動範本。 |
sg-bp15ed6xe1yxeycg**** |
|
| LaunchConfiguration.SystemDisk |
object |
否 |
執行個體的系統磁碟資訊。同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
|
| Encrypted |
string |
否 |
系統磁碟 N 是否加密。取值範圍:
預設值:false。 同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
false |
| KMSKeyId |
string |
否 |
系統磁碟對應的 KMS 金鑰 ID。 同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| EncryptAlgorithm |
string |
否 |
系統磁碟加密演算法。取值範圍:
預設值:aes-256。 同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。 說明
該參數暫未開放使用。 |
aes-256 |
| ProvisionedIops |
integer |
否 |
ESSD AutoPL 雲端硬碟預先配置的讀寫 IOPS。可能值:0~min{50,000, 1000*容量-基準效能}。 基準效能=min{1,800+50*容量, 50,000}。 說明
當 SystemDisk.Category 取值為 cloud_auto 時才支援設定該參數。更多資訊,請參閱ESSD AutoPL 雲端硬碟。 |
40000 |
| BurstingEnabled |
boolean |
否 |
是否開啟 Burst(效能突增)。取值範圍:
說明
當 |
false |
| AutoSnapshotPolicyId |
string |
否 |
系統磁碟採用的自動快照原則 ID。 當您設定該參數後,需要注意:
|
sp-bp67acfmxazb4p**** |
| LaunchConfiguration.Arn |
array<object> |
否 |
說明
該參數正在邀測中,暫不支援使用。 |
|
|
object |
否 |
說明
該參數正在邀測中,暫不支援使用。 |
||
| Rolearn |
string |
否 |
說明
該參數正在邀測中,暫不支援使用。 |
acs:ram::123456789012****:role/adminrole |
| RoleType |
string |
否 |
說明
該參數正在邀測中,暫不支援使用。 |
34458433936495****:alice |
| AssumeRoleFor |
integer |
否 |
說明
該參數正在邀測中,暫不支援使用。 |
123456789012**** |
| HibernationOptionsConfigured |
boolean |
否 |
說明
該參數正在邀測中,暫未開放使用。 |
false |
| LaunchConfiguration.AutoReleaseTime |
string |
否 |
按量付費執行個體的自動釋放時間。按照ISO 8601標準表示,使用 UTC+0 時間。格式為:
|
2018-01-01T12:05:00Z |
| LaunchConfiguration.ImageFamily |
string |
否 |
映像族系名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以 |
hangzhou-daily-update |
| Tag |
array<object> |
否 |
彈性供應群組綁定的標籤清單。 |
|
|
object |
否 |
彈性供應群組綁定的標籤。 |
||
| Key |
string |
否 |
彈性供應群組的標籤鍵。 N 的取值範圍:1~20。一旦傳入該值,則不允許為空字串。最多支援 128 個字元,不能以 aliyun 和 acs:開頭,不能包含 http://或者 https://。 |
TestKey |
| Value |
string |
否 |
彈性供應群組的標籤值。 N 的取值範圍:1~20。一旦傳入該值,允許為空字串。最多支援 128 個字元,不能包含 http://或者 https://。 |
TestValue |
| ResourcePoolOptions |
object |
否 |
建立執行個體時使用的資源集區策略。當您設定該參數後,需要注意:
|
|
| Strategy |
string |
否 |
資源集區包括彈性保障服務或容量預定服務生效後產生的私有集區以及公用集區,供執行個體啟動時選擇。取值範圍:
預設值:PublicPoolOnly。 |
PrivatePoolFirst |
| PrivatePoolIds |
array |
否 |
私有集區 ID 清單。取值範圍:1~20。 |
|
|
string |
否 |
私有集區 ID。即彈性保障服務 ID 或容量預定服務 ID。該參數只能傳入 Target 模式私有集區 ID。 |
eap-bp67acfmxazb4**** |
|
| LaunchConfiguration |
object |
否 |
啟動設定參數。 |
|
| Period |
integer |
否 |
購買資源的時長,單位由 PeriodUnit=Month 時,Period 取值:1、2、3、6、12。 |
1 |
| PeriodUnit |
string |
否 |
包年包月計費方式的時長單位。取值範圍: Month(預設)。 |
Month |
| AutoRenew |
boolean |
否 |
是否要自動續費。建立包年包月執行個體時生效。取值範圍:
|
true |
| AutoRenewPeriod |
integer |
否 |
單次自動續費的續費時長。取值範圍: PeriodUnit=Month 時:1、2、3、6、12、24、36、48、60。 預設值:1。 |
1 |
| SpotDuration |
integer |
否 |
搶占式執行個體的保留時長,單位為小時。 預設值:1。取值範圍:
執行個體回收前 5 分鐘阿里雲會透過 ECS 系統事件向您傳送通知。搶占式執行個體按秒計費,建議您結合具體任務執行耗時來選擇合適的保留時長。 當您設定該參數後,需要注意:
|
1 |
| SpotInterruptionBehavior |
string |
否 |
搶占式執行個體中斷模式。取值範圍:
關於節省停機模式的更多說明,請參閱節省停機模式。 預設值:Terminate。 當您設定該參數後,需要注意:
|
Terminate |
| ImageOptions |
object |
否 |
映像相關屬性資訊。 當您設定該參數後,需要注意:
|
|
| LoginAsNonRoot |
boolean |
否 |
使用該映像的執行個體是否支援使用 ecs-user 使用者登入。可能值:
|
false |
| SchedulerOptions |
object |
否 |
排程選項。 |
|
| DedicatedHostId |
string |
否 |
專屬主機 ID。 |
|
| DedicatedHostClusterId |
string |
否 |
專屬主機叢集 ID。 |
|
| SecurityOptions |
object |
否 |
執行個體安全性選項。 |
|
| TrustedSystemMode |
string |
否 |
||
| CpuOptions |
object |
否 |
CPU 相關設定。 |
|
| Core |
integer |
否 |
CPU 核心數。 預設值:請參閱自訂 CPU 選項。 |
2 |
| ThreadsPerCore |
integer |
否 |
CPU 執行緒數。ECS 執行個體的 vCPU 數=CpuOptions.Core 取值*CpuOptions.ThreadsPerCore 取值。 CpuOptions.ThreadsPerCore=1 表示關閉 CPU 超執行緒。 僅部分執行個體規格支援設定 CPU 執行緒數。 取值範圍和預設值:請參閱自訂 CPU 選項。 |
2 |
| PrePaidOptions |
object |
否 |
包年包月執行個體的容量詳細設定。 |
|
| SpecifyCapacityDistribution |
array<object> |
否 |
不同執行個體規格的最小容量集合。僅當 |
|
|
object |
否 |
執行個體規格的最小容量。 |
||
| InstanceTypes |
array |
否 |
執行個體規格集合。不允許重複,且規格在 LaunchTemplateConfig.InstanceType 範圍內。 |
|
|
string |
否 |
執行個體規格。 |
ecs.c6.large |
|
| MinTargetCapacity |
integer |
否 |
在 說明
|
5 |
| ExecutionMode |
string |
否 |
||
| CandidateOptions |
object |
否 |
當 AutoProvisioningGroupType = candidate 時的設定選項。 |
|
| TimeoutMinutes |
integer |
否 |
彈性供應群組嘗試擴充出目標容量執行個體的逾時時間,逾時後不再嘗試擴充。單位:分鐘。 |
60 |
| Evaluate |
boolean |
否 |
本次請求是否只評估候補交付目標容量的成功率,設定為 true 時,不會進行擴充,只評估交付的成功率並在請求回應 LaunchResult.CandidateEvaluateLevel 中傳回。預設值為 false。 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| AutoProvisioningGroupId |
string |
彈性供應群組的 ID。 |
apg-sn54avj8htgvtyh8**** |
| RequestId |
string |
請求 ID。 |
745CEC9F-0DD7-4451-9FE7-8B752F39**** |
| LaunchResults |
object |
||
| LaunchResult |
array<object> |
彈性供應群組建立的執行個體組成的集合。該集合值僅當彈性供應群組的交付類型為一次性同步交付( |
|
|
array<object> |
彈性供應群組建立的執行個體資訊。 |
||
| ZoneId |
string |
執行個體所在的可用區 ID。 |
cn-hangzhou-g |
| ErrorMsg |
string |
當執行個體建立失敗時,傳回的錯誤資訊。 |
Specific parameter is not valid. |
| InstanceType |
string |
執行個體規格。 |
ecs.g5.large |
| ErrorCode |
string |
當執行個體建立失敗時,傳回的錯誤碼。 |
InvalidParameter |
| SpotStrategy |
string |
按量付費執行個體的搶占策略。可能值:
|
NoSpot |
| Amount |
integer |
成功建立的執行個體 ID 清單內的執行個體數量。 |
1 |
| InstanceIds |
object |
||
| InstanceId |
array |
成功建立的執行個體 ID 清單。 |
|
|
string |
成功建立的執行個體 ID 清單。 |
["i-bp67acfmxazb4p****"] |
|
| CandidateEvaluateLevel |
string |
當 CandidateOptions.Evaluate = true 時傳回當前規格的候補成功率。可能值 Low、Medium、High。 |
Low |
樣本
正常返回樣本
JSON格式
{
"AutoProvisioningGroupId": "apg-sn54avj8htgvtyh8****",
"RequestId": "745CEC9F-0DD7-4451-9FE7-8B752F39****",
"LaunchResults": {
"LaunchResult": [
{
"ZoneId": "cn-hangzhou-g",
"ErrorMsg": "Specific parameter is not valid.",
"InstanceType": "ecs.g5.large",
"ErrorCode": "InvalidParameter",
"SpotStrategy": "NoSpot",
"Amount": 1,
"InstanceIds": {
"InstanceId": [
"[\"i-bp67acfmxazb4p****\"]"
]
},
"CandidateEvaluateLevel": "Low"
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | %s | 目前的請求參數不合法,請重試。 |
| 400 | InvalidAutoProvisioningGroupName.Malformed | The specified parameter "AutoProvisioningGroupName" is not valid. | 指定的參數「AutoProvisioningGroupName」無效。 |
| 400 | InvalidAutoProvisioningGroupType.ValueNotSupported | The specified parameter "AutoProvisioningGroupType" is not supported. | |
| 400 | InvalidFleetExcessCapacityTerminationPolicy.ValueNotSupported | The specified parameter "ExcessCapacityTerminationPolicy" is not supported. | |
| 400 | InvalidDefaultTargetCapacityType.ValueNotSupported | The specified parameter "DefaultTargetCapacityType" is not supported. | |
| 400 | InvalidSpotAllocationStrategy.ValueNotSupported | The specified parameter "SpotAllocationStrategy" is not supported. | |
| 400 | InvalidSpotInstanceInterruptionBehavior.ValueNotSupported | The specified parameter "SpotInstanceInterruptionBehavior" is not supported. | |
| 400 | InvalidPayAsYouGoAllocationStrategy.ValueNotSupported | The specified parameter "PayAsYouGoAllocationStrategy" is not supported. | |
| 400 | MissingParameter.SpotAllocationStrategy | The specified parameter "SpotAllocationStrategy" is empty. | |
| 400 | MissingParameter.LaunchTemplateConfigs | The specified parameter "LaunchTemplateConfigs" is empty. | 指定的LaunchTemplateConfigs參數為空。 |
| 400 | InvalidValidTime.MalFormed | The specified parameter "ValidTime" is not supported. | |
| 400 | InvalidLaunchTemplateVersion.ValueNotSupported | The specified parameter "LaunchTemplateVersion" is not valid. | |
| 400 | MissingParameter | The specified parameter "AutoProvisioningGroup" should not be null. | |
| 400 | InvalidRegion.ValueNotSupported | The specified Region does not exist. | |
| 400 | InvalidDescription.ValueNotSupported | The specified description is illegal. | |
| 400 | InvalidLaunchTemplate.ValueNotSupported | The SecurityGroupId or imageId in LaunchTemplate is not exists. | 啟動範本中的安全性群組ID或映像ID不存在。 |
| 400 | InvalidCapacity.ValueNotSupported | The Capacity is illegal, or the TargetCapacity is large than SpotCapacity + PayAsYouGoCapacity. | |
| 400 | InvalidInstanceType.ValueNotSupported | The instanceType is illegal. | |
| 400 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤,請重試。 |
| 400 | InvalidLaunchTemplateConfigs.SizeExceed | The size of LaunchTemplateConfigs exceeds limit. | 彈性供應群組中的LaunchTemplateConfig數量超過限制。 |
| 400 | InvalidParameter.SpotInstancePoolsToUseCount | The specified parameter "SpotInstancePoolsToUseCount" is not valid. | |
| 400 | InvalidParameter.ResourceGroupId | The specified parameter "ResourceGroupId" is not valid. | |
| 400 | InvalidParameter.TargetCapacity | The Capacity is illegal, TotalTargetCapacity, PayAsYouGoTargetCapacity, SpotTargetCapacity must be specified, meanwhile, the TargetCapacity must be larger than or equal to the sum of SpotCapacity and OnDemandCapacity. | |
| 400 | MissingParameter.WeightedCapacity | The WeightedCapacity of LaunchTemplateConfig should not be empty. | |
| 400 | InvalidParameter.WeightedCapacityBeyondRange | The WeightedCaTpacity of LaunchTemplateConfig beyond permitted range. | |
| 400 | InvalidParameter.MaxPrice | The specified parameter "MaxSpotPrice" or "MaxPrice" of LaunchTemplateConfig is not valid. | |
| 400 | NoPermission | %s | |
| 400 | Duplicate.DiskCategory | The specified disk configs contains duplicate DiskCategory. | |
| 400 | InvalidImageFamily.Confict | The specified parameter ImageFamily should be empty when the parameter ImageId is specified. | 當填寫映像ID時,參數ImageFamily必須為空。 |
| 400 | Invalid.ResourcePoolOptions.PrivatePoolIds | The zone or instancetype of the ResourcePoolOptions.PrivatePoolIds does not match the LaunchTemplateConfig. | 指定的ResourcePoolOptions.PrivatePoolIds參數對應的可用區或規格不在擴充啟動範本可用區範圍內。 |
| 400 | Invalid.ResourcePoolOptions.Strategy | The specified ResourcePoolOptions.Strategy is invalid. | 指定的ResourcePoolOptions.Strategy參數有誤。 |
| 400 | Invalid.ResourcePoolOptionsPrivatePoolIds.SizeExceed | The size of ResourcePoolOptions.PrivatePoolIds exceeds limit. | ResourcePoolOptions.PrivatePoolIds參數大小超出了限制。 |
| 400 | MissingParameter.ResourcePoolOptions.PrivatePoolIds | The specified ResourcePoolOptions.PrivatePoolIds should not be null when ResourcePoolOptions.Strategy is PrivatePoolOnly. | 當 ResourcePoolOptions.Strategy參數值為 PrivatePoolOnly 時,ResourcePoolOptions.PrivatePoolIds 參數不能為空。 |
| 400 | InvalidSpotDuration | The specified SpotDuration is not valid. | 指定的 SpotDuration 參數有誤。 |
| 400 | InvalidSpotInterruptionBehavior | %s | SpotInterruptionBehavior 不支援。 |
| 400 | InvalidParameter.SecurityGroupIdRepeated | The SecurityGroupId is repeated. | 指定的安全性群組已重複新增。請檢查 SecurityGroupIds 參數值是否正確。 |
| 400 | VpcMismatch.SecurityGroupAndVSwitch | Specified security group and virtual switch are not in the same VPC. | 指定的安全性群組與虛擬交換器不在同一專有網路中。 |
| 400 | InvalidMinTargetCapacity.NotSatisfied | The inventory of specified InstanceType does not meet the MinTargetCapacity. | 執行個體類型對應的庫存不能滿足目標最小容量。 |
| 400 | InvalidParameterRange.MinTargetCapacity | The MinTargetCapacity exceeds the limit[0-TotalTargetCapacity]. | 目標最小容量超出限制 [0-總容量]。 |
| 400 | InvalidUserData.Base64FormatInvalid | The specified parameter UserData must be base64 encoded. | 指定的 UserData 不合法。 |
| 400 | InvalidUserData.SizeExceeded | The specified parameter UserData exceeds the size. | 指定的 UserData 超過大小限制。 |
| 400 | InvalidAutoReleaseTime.Malformed | The specified parameter AutoReleaseTime is not valid. | 自動釋放格式錯誤。請按照 ISO 8601 標準表示,並需要使用 UTC 時間,格式為:yyyy-MM-ddTHH:mm:ssZ。 |
| 400 | QuotaExceeded.AutoProvisioningGroup | The count of AutoProvisioningGroup exceeds the limit. | 彈性供應群組數量達到限額。 |
| 400 | Invalid.PrivatePoolOptions.status | The PrivatePool status is not valid. | 指定的私有池狀態不正確。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | TotalTargetCapacityLimitExceed | The TotalTargetCapacity exceeds the limit[0-2000]. | TotalTargetCapacity 值超過限制 [0~2000]。 |
| 403 | SpotTargetCapacityLimitExceed | The SpotTargetCapacity exceeds the limit[0-2000]. | SpotTargetCapacity 超過限制範圍 [0-2000]。 |
| 403 | PayAsYouGoTargetCapacityLimitExceed | The PayAsYouGoTargetCapacity exceeds the limit[0-2000]. | PayAsYouGoTargetCapacity 容量超過限制 [0-2000]。 |
| 403 | OperationDenied.NoStock | The resource is out of stock in the specified zone. Please try other types, or choose other regions and zones. | 指定的可用區或叢集中不存在指定磁碟類別,或指定的可用區與叢集不匹配。 |
| 403 | CandidateDenied.NoStock | The resource is out of stock and there are no candidate resources in the specified zone. Please try other types, or choose other regions and zones. | 當前執行個體規格資源已售罄,且短期內無候補資源,請根據需求選擇其他執行個體規格或者可用區。 |
| 404 | InvalidResourcePoolOptionsPrivatePoolIds.NotFound | The ResourcePoolOptions.PrivatePoolIds do not exist. | 私有集區不存在。 |
| 404 | InvalidSecurityGroupId.NotFound | The SecurityGroupId %s provided does not exist in our records. | 指定的安全性群組在該使用者帳號下不存在,請您檢查安全性群組 id 是否正確。 |
| 404 | InvalidVSwitchId.NotFound | The specified virtual switch %s does not exist. | 指定的虛擬交換器 ID 不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。