全部產品
Search
文件中心

Elastic Compute Service:CreateAutoProvisioningGroup

更新時間:Jul 01, 2026

建立一個彈性供應組。

介面說明

  • 彈性供應是一個使用搶佔式執行個體和隨用隨付執行個體快速部署執行個體叢集的方案,支援一鍵部署跨計費方式、跨可用區、跨執行個體規格族的執行個體叢集。更多資訊,請參見使用彈性供應組 API 批次建立 ECS 執行個體

  • 彈性供應以供應組為載體調度和維護運算資源,您可以透過彈性供應組穩定提供運算力,緩解搶佔式執行個體的回收機制帶來的不穩定因素。

  • 彈性供應為免費功能,但是您需要為透過彈性供應組建立出的執行個體資源付費。更多資訊,請參見搶佔式執行個體計費隨用隨付

  • 當您同時指定啟動範本(LaunchTemplateId)與啟動配置資訊(LaunchConfiguration.*)時,系統優先使用啟動範本。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:CreateAutoProvisioningGroup

create

*All Resource

*

  • ram:CreateServiceLinkedRole

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

彈性供應組所在地域的 ID,您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。

cn-hangzhou

ResourceGroupId

string

彈性供應組所在的企業資源群組 ID。

rg-bp67acfmxazb4p****

AutoProvisioningGroupName

string

彈性供應組的名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以http://https://開頭。可以包含數字、半形冒號(:)、底線(_)或者短劃線(-)。

apg-test

AutoProvisioningGroupType

string

彈性供應組的交付類型。取值範圍:

  • request:一次性非同步交付。供應組僅在啟動時非同步交付執行個體叢集,調度失敗後不再重試。

  • instant:一次性同步交付。供應組僅在啟動時同步建立執行個體,並在請求回應中返回建立成功的執行個體列表和建立失敗的原因。

  • maintain:持續供應。供應組在啟動時嘗試交付執行個體叢集,並監控即時容量,未達到目標容量則嘗試繼續建立 ECS 執行個體。

預設值:maintain。

maintain

SpotAllocationStrategy

string

建立搶佔式執行個體的策略。取值範圍:

  • lowest-price:成本最佳化策略。選擇價格最低的執行個體規格。

  • diversified:均衡可用區分佈策略。在擴展啟動範本指定的可用區內建立執行個體,均勻分佈到各可用區。

  • capacity-optimized:容量最佳化分佈策略。根據庫存情況,選擇最優的執行個體規格和可用區進行建立。

預設值:lowest-price。

diversified

SpotInstanceInterruptionBehavior

string

競價執行個體中斷時的行為。取值範圍:

  • stop:停止執行個體。

  • terminate:釋放執行個體。

預設值:terminate。

terminate

SpotInstancePoolsToUseCount

integer

SpotAllocationStrategylowest-price時生效,表示彈性供應組選擇價格最低的執行個體規格建立執行個體的數量。

取值範圍:低於LaunchTemplateConfig.N中 N 的取值。

2

PayAsYouGoAllocationStrategy

string

建立隨用隨付執行個體的策略。取值範圍:

  • lowest-price:成本最佳化策略。選擇價格最低的執行個體規格。

  • prioritized:優先順序策略。按照LaunchTemplateConfig.N.Priority設定的優先順序建立執行個體。

預設值:lowest-price。

prioritized

ExcessCapacityTerminationPolicy

string

彈性供應組即時容量超過目標容量並觸發縮容時,是否釋放縮容的執行個體。取值範圍:

  • termination:釋放縮容的執行個體。

  • no-termination:只將縮容的執行個體移出彈性供應組。

預設值:no-termination。

termination

ValidFrom

string

彈性供應組的啟動時間,和ValidUntil共同確定有效時段。

按照ISO 8601標準表示,並使用 UTC+0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。

預設值:該介面立即生效的時間戳記。

2019-04-01T15:10:20Z

ValidUntil

string

彈性供應組的到期時間,和ValidFrom共同確定有效時段。

按照ISO 8601標準表示,並使用 UTC+0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。

預設值:2099-12-31T23:59:59Z。

2019-06-01T15:10:20Z

TerminateInstancesWithExpiration

boolean

彈性供應組到期時,是否釋放組內執行個體。取值範圍:

  • true:釋放組內執行個體。

  • false:只將組內執行個體移出彈性供應組。

預設值:false。

true

TerminateInstances

boolean

刪除彈性供應組時,是否釋放組內執行個體。取值範圍:

  • true:釋放組內執行個體。

  • false:保留組內執行個體。

預設值:false。

true

MaxSpotPrice

number

彈性供應組內搶佔式執行個體的最高價格。

說明

同時設定了MaxSpotPriceLaunchTemplateConfig.N.MaxPrice時,以最低值為準。

2

TotalTargetCapacity

string

彈性供應組的目標總容量。取值範圍:正整數。

總容量必須大於等於PayAsYouGoTargetCapacity(指定的隨用隨付執行個體目標容量)和SpotTargetCapacity(指定的搶佔式執行個體目標容量)取值之和。

60

PayAsYouGoTargetCapacity

string

彈性供應組內,隨用隨付執行個體的目標容量。取值範圍:小於等於TotalTargetCapacity的參數取值。

30

SpotTargetCapacity

string

彈性供應組內,搶佔式執行個體的目標容量。取值範圍:小於等於TotalTargetCapacity的參數取值。

20

DefaultTargetCapacityType

string

PayAsYouGoTargetCapacitySpotTargetCapacity之和小於TotalTargetCapacity時,指定差額容量的計費方式。取值範圍:

  • PayAsYouGo:隨用隨付執行個體。

  • Spot:搶佔式執行個體。

預設值:Spot。

Spot

LaunchTemplateId

string

彈性供應組關聯的執行個體啟動範本的 ID,您可以呼叫 DescribeLaunchTemplates 查詢可用的執行個體啟動範本。同時指定啟動範本與啟動配置資訊(LaunchConfiguration.*)時,優先使用啟動範本。

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:非 I/O 最佳化。

  • optimized:I/O 最佳化。

已停售的執行個體規格執行個體預設值是 none,其他執行個體規格預設值是 optimized。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

optimized

LaunchConfiguration.InternetChargeType

string

網路計費類型。取值範圍:

  • PayByBandwidth:按固定頻寬計費。

  • PayByTraffic:按使用流量計費。

說明

按使用流量計費模式下的出入頻寬峰值都是頻寬上限,不作為業務承諾指標。當出現資源爭搶時,頻寬峰值可能會受到限制。如果您的業務需要有頻寬的保障,請使用按固定頻寬計費模式。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

PayByTraffic

LaunchConfiguration.InternetMaxBandwidthIn

integer

公網入頻寬最大值,單位為 Mbit/s。取值範圍:

  • 當公網出頻寬小於等於 10 Mbit/s 時:1~10,預設為 10。

  • 當公網出頻寬大於 10 Mbit/s 時:1~LaunchConfiguration.InternetMaxBandwidthOut的取值,預設為LaunchConfiguration.InternetMaxBandwidthOut的取值。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

10

LaunchConfiguration.InternetMaxBandwidthOut

integer

公網出頻寬最大值,單位為 Mbit/s。取值範圍:0~100。

預設值:0。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

10

LaunchConfiguration.InstanceName

string

執行個體名稱。長度為 2~128 個字元,必須以大小寫字母或中文開頭,不能以http://https://開頭。可以包含中文、英文、數字、半形冒號(:)、底線(_)、半形句號(.)或者短劃線(-)。

預設值:執行個體的InstanceId

建立多台 ECS 執行個體時,您可以批次設定有序的執行個體名稱。具體操作,請參見批次設定有序的執行個體名稱或主機名稱

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

k8s-node-[1,4]-alibabacloud

LaunchConfiguration.HostName

string

執行個體主機名稱。限制說明如下:

  • 半形句號(.)和短劃線(-)不能作為首尾字元,更不能連續使用。

  • Windows 執行個體:字元長度為 2~15,不支援半形句號(.),不能全是數字。允許大小寫英文字母、數字和短劃線(-)。

  • 其他類型執行個體(Linux 等):字元長度為 2~64,支援多個半形句號(.),點之間為一段,每段允許大小寫英文字母、數字和短劃線(-)。

  • 不支援同時設定LaunchConfiguration.HostNameLaunchConfiguration.HostNames.N,否則會返回報錯資訊。

  • 同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

k8s-node-[1,4]-ecshost

LaunchConfiguration.InstanceDescription

string

執行個體描述。長度為 2~256 個英文或中文字元,不能以http://https://開頭。同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

Instance_Description

LaunchConfiguration.KeyPairName

string

金鑰對名稱。

  • Windows 執行個體,忽略該參數。預設為空。

  • Linux 執行個體的密碼登入方式會被初始化成禁止。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

KeyPair_Name

LaunchConfiguration.RamRoleName

string

執行個體 RAM 角色名稱。您可以使用 RAM API ListRoles 查詢您已建立的執行個體 RAM 角色。同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

RAM_Name

LaunchConfiguration.SecurityEnhancementStrategy

string

是否開啟安全性加固。取值範圍:

  • Active:啟用安全性加固,只對公共映像生效。

  • Deactive:不啟用安全性加固,對所有映像類型生效。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

Active

LaunchConfiguration.UserData

string

執行個體自訂資料。需要以 Base64 方式編碼,原始資料最多為 32 KB。同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

ZWNobyBoZWxsbyBlY3Mh

LaunchConfiguration.SystemDiskCategory

string

系統磁碟的雲端硬碟種類。取值範圍:

  • cloud_efficiency:高效雲端硬碟。

  • cloud_ssd:SSD 雲端硬碟。

  • cloud_essd:ESSD 雲端硬碟。

  • cloud:普通雲端硬碟。

已停售的執行個體規格且非 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 個英文或中文字元。必須以大小寫字母或中文開頭,不能以http://https://開頭。可以包含數字、半形句號(.)、半形冒號(:)、底線(_)或者短劃線(-)。

預設值:空。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

cloud_ssdSystem

LaunchConfiguration.SystemDiskDescription

string

系統磁碟的描述。長度為 2~256 個英文或中文字元,不能以http://https://開頭。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

SystemDisk_Description

LaunchConfiguration.SystemDiskPerformanceLevel

string

建立 ESSD 雲端硬碟作為系統磁碟使用時,設定雲端硬碟的效能等級。取值範圍:

  • PL0(預設):單碟最高隨機讀寫 IOPS 1 萬。

  • PL1:單碟最高隨機讀寫 IOPS 5 萬。

  • PL2:單碟最高隨機讀寫 IOPS 10 萬。

  • PL3:單碟最高隨機讀寫 IOPS 100 萬。

有關如何選擇 ESSD 效能等級,請參見 ESSD 雲端硬碟

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

PL0

LaunchConfiguration.PasswordInherit

boolean

是否使用映像預設的密碼。取值範圍:

  • true:使用。

  • false:不使用。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

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 執行個體的可用區由虛擬交換機決定。

說明

設定了LaunchTemplateConfig後,LaunchTemplateConfig.N.VSwitchId為必選參數。

vsw-sn5bsitu4lfzgc5o7****

MaxPrice

number

擴展啟動範本中,搶佔式執行個體的價格上限。

說明

設定了LaunchTemplateConfig後,LaunchTemplateConfig.N.MaxPrice為必選參數。

3

Priority

integer

擴展啟動範本的優先順序,取值為 0 時優先順序最高。取值範圍:0 ~ +∞。

1

InstanceType

string

擴展啟動範本對應的執行個體規格,N 的取值範圍:1~20。取值範圍:請參見執行個體規格族

ecs.g5.large

WeightedCapacity

number

擴展啟動範本中,執行個體規格的權重。取值越高,單台執行個體滿足運算力需求的能力越大,所需的執行個體數量越小。取值範圍:大於 0。

您可以根據指定執行個體規格的運算力和叢集單節點最低運算力得出權重值。假設單節點最低運算力為 8 vCPU、60 GiB,則:

  • 8 vCPU、60 GiB 的執行個體規格權重可以設定為 1。

  • 16 vCPU、120 GiB 的執行個體規格權重可以設定為 2。

2

MaxQuantity

integer

說明

該參數正在邀測中,暫不支援使用。

false

Cores

array

執行個體規格的 vCPU 核心數目列表。

integer

執行個體規格的 vCPU 核心數目,用於篩選符合要求的執行個體規格範圍。更多資訊,請參見執行個體規格族。N 的取值範圍:1~10。

2

Memories

array

執行個體規格的記憶體大小列表。

number

執行個體規格的記憶體大小,單位為 GiB,用於篩選符合要求的執行個體規格範圍。更多資訊,請參見執行個體規格族。N 的取值範圍:1~10。

4

InstanceFamilyLevel

string

執行個體規格族級別,用於篩選符合要求的執行個體規格範圍。取值範圍:

  • EntryLevel:入門級,即共用型執行個體規格。成本更低,但是無法保證執行個體運算效能的穩定。適用於平時 CPU 使用率低的業務場景。更多資訊,請參見共用型

  • EnterpriseLevel:企業級。效能穩定,資源獨享,適用於對穩定性要求高的業務場景。更多資訊,請參見執行個體規格族

  • CreditEntryLevel:積分入門級,即突發效能執行個體。透過 CPU 積分來保證運算效能,適用於平時 CPU 使用率低、偶有突發 CPU 使用率的情況。更多資訊,請參見突發效能執行個體

N 的取值範圍:1~10。

EnterpriseLevel

ExcludedInstanceTypes

array

需要排除的執行個體規格列表。

string

需要排除的執行個體規格。透過使用萬用字元(*)可以排除單個規格或者整個規格族。例如:

  • ecs.c6.large:表示排除 ecs.c6.large 執行個體規格。

  • ecs.c6.*:表示排除整個 c6 規格族的執行個體規格。

ecs.n1.small/ecs.n1.*/*7*

Architectures

array

執行個體規格所屬的架構類型列表。

string

執行個體規格所屬的架構類型。取值範圍:

  • X86:X86 運算。

  • Heterogeneous:異構運算,例如 GPU 或 FPGA 等。

  • BareMental:彈性裸金屬伺服器。

  • Arm:Arm 運算。

  • SuperComputeCluster:超級運算叢集。

預設值:包含所有架構類型。

X86

BurstablePerformance

string

是否為效能突發執行個體規格。取值範圍:

  • Exclude:不包含效能突發執行個體規格。

  • Include:包含效能突發執行個體規格。

  • Required:只包含效能突發執行個體規格。

預設值:Include。

Include

ImageId

string

映像 ID,您可以透過該參數設定當前資源池使用的映像,如果沒有設定則預設使用 LaunchConfiguration.ImageId或者啟動範本裡配置的映像資訊。您可以透過 DescribeImages 查詢可用的映像資源。 注:僅當AutoProvisioningGroupType = instant 時支援該參數。

aliyun_3_x64_20G_alibase_20210425.vhd

LaunchConfiguration.DataDisk

array<object>

擴展啟動範本雲端硬碟配置列表。

object

擴展啟動範本雲端硬碟配置資訊。

PerformanceLevel

string

建立 ESSD 雲端硬碟作為資料磁碟使用時,設定雲端硬碟的效能等級。N 的取值必須和LaunchConfiguration.DataDisk.N.Category中的 N 保持一致。取值範圍:

  • PL0:單碟最高隨機讀寫 IOPS 1 萬。

  • PL1(預設):單碟最高隨機讀寫 IOPS 5 萬。

  • PL2:單碟最高隨機讀寫 IOPS 10 萬。

  • PL3:單碟最高隨機讀寫 IOPS 100 萬。

有關如何選擇 ESSD 效能等級,請參見 ESSD 雲端硬碟

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

PL1

KmsKeyId

string

資料磁碟對應的 KMS 金鑰 ID。同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。

0e478b7a-4262-4802-b8cb-00d3fb40****

Description

string

資料磁碟的描述。長度為 2~256 個英文或中文字元,不能以http://https://開頭。同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

DataDisk_Description

SnapshotId

string

建立資料磁碟 N 使用的快照。N 的取值範圍為 1~16。

指定該參數後,參數LaunchConfiguration.DataDisk.N.Size會被忽略,實際建立的雲端硬碟大小為指定的快照的大小。不能使用早於 2013 年 7 月 15 日(含)建立的快照,請求會報錯被拒絕。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

s-bp17441ohwka0yuh****

Size

integer

第 N 個資料磁碟的容量大小,N 的取值範圍為 1~16,單位為 GiB。取值範圍:

  • cloud_efficiency:20~32768。

  • cloud_ssd:20~32768。

  • cloud_essd:具體取值範圍與LaunchConfiguration.DataDisk.N.PerformanceLevel的取值有關。
    • PL0:40~32768。

    • PL1:20~32768。

    • PL2:461~32768。

    • PL3:1261~32768

  • cloud:5~2000。

說明

該參數的取值必須大於等於參數LaunchConfiguration.DataDisk.N.SnapshotId指定的快照的大小。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

20

Device

string

資料磁碟的掛載點。同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

/dev/vd1

DiskName

string

資料磁碟名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以http://https://開頭。可以包含數字、半形句號(.)、半形冒號(:)、底線(_)或者短劃線(-)。

預設值:空。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

cloud_ssdData

Category

string

資料磁碟 N 的雲端硬碟類型。N 的取值範圍為 1~16。取值範圍:

  • cloud_efficiency:高效雲端硬碟。

  • cloud_ssd:SSD 雲端硬碟。

  • cloud_essd:ESSD 雲端硬碟。

  • cloud:普通雲端硬碟。

對於 I/O 最佳化執行個體,預設值為 cloud_efficiency。對於非 I/O 最佳化執行個體,預設值為 cloud。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

cloud_ssd

DeleteWithInstance

boolean

資料磁碟是否隨執行個體釋放。取值範圍:

  • true:資料磁碟隨執行個體釋放。

  • false:資料磁碟不隨執行個體釋放。

預設值:true。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

true

Encrypted

boolean

資料磁碟 N 是否加密。取值範圍:

  • true:加密。

  • false:不加密。

預設值:false。

同時指定啟動範本與啟動配置資訊時,優先使用啟動範本。

false

EncryptAlgorithm

string

說明

該參數暫未開放使用。

null

ProvisionedIops

integer

ESSD AutoPL 雲端硬碟預配置的讀寫 IOPS。可能值:0~min{50,000, 1000*容量-基準效能}。

基準效能=min{1,800+50*容量 ESSD AutoPL 云盘

40000

BurstingEnabled

boolean

是否开启 Burst(性能突发)。取值范围:

  • true:是。

  • false:否。

說明

当 DiskCategory 取值为 cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘

false

AutoSnapshotPolicyId

string

数据盘采用的自动快照策略 ID。

当您设置该参数后,需要注意:

  • 仅创建一次性同步交付类型的弹性供应组(AutoProvisioningGroupType=instant)时,该参数生效。

sp-bp67acfmxazb4p****

LaunchConfiguration.Tag

array<object>

扩展启动模板标签列表。

object

扩展启动模板标签信息。

Key

string

实例的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含http://https://。同时指定启动模板与启动配置信息时,优先使用启动模板。

TestKey

Value

string

实例的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能以 acs:开头,不能包含http://或者https://。同时指定启动模板与启动配置信息时,优先使用启动模板。

TestValue

SystemDiskConfig

array<object>

实例系统盘信息列表。

object

实例系统盘信息。

DiskCategory

string

实例系统盘类型。您可通过该参数指定多种候选磁盘类型,指定顺序作为各磁盘类型的优先级顺序,当某一种磁盘不可用时,自动更换磁盘类型。取值范围:

  • cloud_efficiency:高效云盘。

  • cloud_ssd:SSD 云盘。

  • cloud_essd:ESSD 云盘。

  • cloud:普通云盘。

cloud_ssd

DataDiskConfig

array<object>

实例数据盘信息列表。

object

实例数据盘信息。

DiskCategory

string

实例数据盘类型。您可通过该参数指定多种候选磁盘类型,指定顺序作为各磁盘类型的优先级顺序,当某一种磁盘不可用时,自动更换磁盘类型。取值范围:

  • cloud_efficiency:高效云盘。

  • cloud_ssd:SSD 云盘。

  • cloud_essd:ESSD 云盘。

  • cloud:普通云盘。

cloud_efficiency

LaunchConfiguration.HostNames

array

为一台或多台实例指定不同的主机名称列表。限制说明如下:

  • 仅创建一次性同步交付类型的弹性供应组(AutoProvisioningGroupType=instant)时,该参数生效。

  • N 表示实例个数,取值范围为 1~1000,且需要和 TotalTargetCapacity 参数值保持一致。

  • 半角句号(.)和短划线(-)不能作为首尾字符,更不能连续使用。

  • 同时指定启动模板与启动配置信息时,优先使用启动模板配置。

ecs-host-01

string

主机名称。限制说明如下:

  • 半角句号(.)和短划线(-)不能作为首尾字符,更不能连续使用。

  • Windows 实例:字符长度为 2~15,不支持半角句号(.),不能全是数字。允许包含大小写英文字母、数字和短划线(-)。

  • 其他类型实例(Linux 等):字符长度为 2~64,支持多个半角句号(.),半角句号(.)之间为一段,每段允许包含大小写英文字母、数字和短划线(-)。

  • 不支持同时设置LaunchConfiguration.HostNameLaunchConfiguration.HostNames.N,否则会返回报错信息。

ecs-host-01

MinTargetCapacity

string

弹性供应组的目标最小容量。取值范围:正整数。

当您设置该参数后,需要注意:

  • 仅创建一次性同步交付类型的弹性供应组(AutoProvisioningGroupType=instant)时,该参数生效。

  • 如果当前地域下的实例库存小于该参数值,则会导致调用接口失败,不会创建实例。

  • 如果当前地域下的实例库存大于该参数值,则按照已设置的其他参数值正常创建实例。

20

LaunchConfiguration.SecurityGroupIds

array

实例所属的安全组列表。

string

執行個體所屬的安全性群組 ID。同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。

sg-bp15ed6xe1yxeycg****

LaunchConfiguration.SystemDisk

object

实例的系统盘信息。同时指定启动模板与启动配置信息时,优先使用启动模板。

Encrypted

string

系统盘 N 是否加密。取值范围:

  • true:加密。

  • false:不加密。

默认值:false。

同时指定启动模板与启动配置信息时,优先使用启动模板。

false

KMSKeyId

string

系統磁碟對應的 KMS 金鑰 ID。

同時指定啟動範本與啟動組態資訊時,優先使用啟動範本。

0e478b7a-4262-4802-b8cb-00d3fb40****

EncryptAlgorithm

string

系统盘加密算法。取值范围:

  • aes-256。

  • sm4-128。

默认值: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(性能突发)。取值范围:

  • true:是。

  • false:否。

說明

SystemDisk.Category取值为cloud_auto时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘

false

AutoSnapshotPolicyId

string

系统盘采用的自动快照策略 ID。

当您设置该参数后,需要注意:

  • 仅创建一次性同步交付类型的弹性供应组(AutoProvisioningGroupType=instant)时,该参数生效。

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 时间。格式为:yyyy-MM-ddTHH:mm:ssZ

  • 如果秒(ss)取值不是00,则自动取为当前分钟(mm)开始时。

  • 最短释放时间为当前时间半小时之后。

  • 最长释放时间不能超过当前时间三年。

2018-01-01T12:05:00Z

LaunchConfiguration.ImageFamily

string

镜像族系名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以aliyunacs:开头,不能包含http://或者https://。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

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

创建实例时使用的资源池策略。当您设置该参数后,需要注意:

  • 该参数只在创建按量付费实例时生效。

  • 仅创建一次性同步交付类型的弹性供应组(AutoProvisioningGroupType=instant)时,该参数生效。

Strategy

string

资源池包括弹性保障服务或容量预定服务生效后生成的私有池以及公共池,供实例启动时选择。取值范围:

  • PrivatePoolFirst:私有池优先。选择此种策略时, 当指定了 ResourcePoolOptions.PrivatePoolIds,优先使用指定的私有池。如果未指定私有池或指定的私有池容量不足,将自动匹配开放类型的私有池。如果没有符合条件的私有池,则使用公共池创建实例。

  • PrivatePoolOnly:仅限私有池。选择此种策略时,必须指定 ResourcePoolOptions.PrivatePoolIds。如果指定的私有池容量不足,则实例会启动失败。

  • PublicPoolOnly:使用公共池创建实例。

默认值:PublicPoolOnly。

PrivatePoolFirst

PrivatePoolIds

array

私有池 ID 列表。取值范围:1~20。

string

私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。

eap-bp67acfmxazb4****

LaunchConfiguration

object

启动配置参数。

Period

integer

购买资源的时长,单位由PeriodUnit指定。当创建包年包月实例时生效且为必选值。取值范围:

PeriodUnit=Month 时,Period 取值:1、2、3、6、12。

1

PeriodUnit

string

包年包月计费方式的时长单位。取值范围:

Month(默认)。

Month

AutoRenew

boolean

是否要自动续费。创建包年包月实例时生效。取值范围:

  • true:自动续费。

  • false(默认):不自动续费。

true

AutoRenewPeriod

integer

单次自动续费的续费时长。取值范围:

PeriodUnit=Month 时:1、2、3、6、12、24、36、48、60。

默认值:1。

1

SpotDuration

integer

抢占式实例的保留时长,单位为小时。 默认值:1。取值范围:

  • 1:创建后阿里云会保证实例运行 1 小时不会被自动释放;超过 1 小时后,系统会自动比较出价与市场价格、检查资源库存,来决定实例的持有和回收。

  • 0:创建后,阿里云不保证实例运行 1 小时,系统会自动比较出价与市场价格、检查资源库存,来决定实例的持有和回收。

实例回收前 5 分钟阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费,建议您结合具体任务执行耗时来选择合适的保留时长。

当您设置该参数后,需要注意:

  • 仅创建一次性同步交付类型的弹性供应组(AutoProvisioningGroupType=instant)时,该参数生效。

1

SpotInterruptionBehavior

string

抢占实例中断模式。取值范围:

  • Terminate:直接释放实例。

  • Stop:实例进入节省停机模式。

关于节省停机模式的更多说明,请参见节省停机模式

默认值:Terminate。

当您设置该参数后,需要注意:

  • 仅创建一次性同步交付类型的弹性供应组(AutoProvisioningGroupType=instant)时,该参数生效。

Terminate

ImageOptions

object

镜像相关属性信息。

当您设置该参数后,需要注意:

  • 仅创建一次性同步交付类型的弹性供应组(AutoProvisioningGroupType=instant)时,该参数生效。

LoginAsNonRoot

boolean

使用该镜像的实例是否支持使用 ecs-user 用户登录。可能值:

  • true:是

  • false:否

false

SchedulerOptions

object

DedicatedHostId

string

DedicatedHostClusterId

string

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>

不同实例规格的最小容量集合。仅当AutoProvisioningGroupType = request 时支持该参数。

object

实例规格的最小容量。

InstanceTypes

array

实例规格集合。不允许重复,且规格在 LaunchTemplateConfig.InstanceType 范围内。

string

執行個體規格。

ecs.c6.large

MinTargetCapacity

integer

InstanceTypes范围内需要交付的最小实例数量。

說明

sum(MinTargetCapacity)<= TotalTargetCapacity,即所有实例规格集合的 MinTargetCapacity 总和不能超过 TotalTargetCapacity,且当任一个实例规格集合由于库存等原因无法满足 MinTargetCapacity 的要求时,整个请求都会创建失败。

5

ExecutionMode

string

CandidateOptions

object

TimeoutMinutes

integer

60

Evaluate

boolean

返回參數

名稱

類型

描述

樣本值

object

AutoProvisioningGroupId

string

弹性供应组的 ID。

apg-sn54avj8htgvtyh8****

RequestId

string

請求 ID。

745CEC9F-0DD7-4451-9FE7-8B752F39****

LaunchResults

object

LaunchResult

array<object>

弹性供应组创建的实例组成的集合。该集合值仅当弹性供应组的交付类型为一次性同步交付(instant)时返回。

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:正常隨用隨付執行個體。

  • SpotWithPriceLimit:設定上限價格的搶佔式執行個體。

  • SpotAsPriceGo:系統自動出價,跟隨當前市場實際價格。

NoSpot

Amount

integer

成功建立的執行個體 ID 列表內的執行個體數量。

1

InstanceIds

object

InstanceId

array

成功建立的執行個體 ID 列表。

string

成功建立的執行個體 ID 列表。

["i-bp67acfmxazb4p****"]

CandidateEvaluateLevel

string

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.
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.
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.
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.
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.
400 Invalid.ResourcePoolOptions.PrivatePoolIds The zone or instancetype of the ResourcePoolOptions.PrivatePoolIds does not match the LaunchTemplateConfig.
400 Invalid.ResourcePoolOptions.Strategy The specified ResourcePoolOptions.Strategy is invalid.
400 Invalid.ResourcePoolOptionsPrivatePoolIds.SizeExceed The size of ResourcePoolOptions.PrivatePoolIds exceeds limit.
400 MissingParameter.ResourcePoolOptions.PrivatePoolIds The specified ResourcePoolOptions.PrivatePoolIds should not be null when ResourcePoolOptions.Strategy is PrivatePoolOnly.
400 InvalidSpotDuration The specified SpotDuration is not valid.
400 InvalidSpotInterruptionBehavior %s
400 InvalidParameter.SecurityGroupIdRepeated The SecurityGroupId is repeated.
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].
400 InvalidUserData.Base64FormatInvalid The specified parameter UserData must be base64 encoded.
400 InvalidUserData.SizeExceeded The specified parameter UserData exceeds the size.
400 InvalidAutoReleaseTime.Malformed The specified parameter AutoReleaseTime is not valid.
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].
403 SpotTargetCapacityLimitExceed The SpotTargetCapacity exceeds the limit[0-2000].
403 PayAsYouGoTargetCapacityLimitExceed The PayAsYouGoTargetCapacity exceeds the limit[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.
404 InvalidVSwitchId.NotFound The specified virtual switch %s does not exist.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情