幫助中心
首頁 Elastic Compute Service 開發參考 API參考 API目錄 啟動模板 CreateLaunchTemplate

CreateLaunchTemplate

更新時間：
Copy as MD
產品

建立一個 ECS 執行個體啟動範本，簡稱範本。執行個體啟動範本能免除每次建立執行個體時都需要填入大量配置參數。

介面說明

呼叫 CreateLaunchTemplate 建立範本後，會自動產生該範本的一個預設版本，版本號為 1，您後續可以基於該範本建立多個版本（CreateLaunchTemplateVersion），版本號從 1 開始順序遞增。如果您在建立執行個體（ RunInstances ）時不指定範本版本號，會採用預設版本。

執行個體啟動範本的版本中包含用於建立執行個體的相關配置，例如執行個體所屬地域、映像 ID、執行個體規格、安全性群組 ID 和公網頻寬等。如果版本中沒有指定某一執行個體配置，您需要在建立執行個體時為執行個體指定該配置。

呼叫該介面時，您需要注意：

  • 每個帳號在一個地域最多能建立 30 個執行個體啟動範本，且每個範本最多能有 30 個版本。

  • 執行個體啟動範本的參數大多數為可選參數。建立範本時，阿里雲不會驗證範本中參數取值的存在性和有效性。只會在真正建立執行個體時校驗參數取值的有效性。

  • 如果執行個體啟動範本中設置了某一配置，建立執行個體（ RunInstances ）時就無法過濾掉該配置。例如，如果範本設置了HostName=LocalHost，RunInstances中HostName取值為空時，執行個體的主機名依然是LocalHost。如果您想覆蓋HostName=LocalHost這一配置，可以在RunInstances中取HostName=MyHost或其他參數值。

調試

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

調試

授權資訊

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

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

  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:CreateLaunchTemplate

create

*LaunchTemplate

acs:ecs:{#regionId}:{#accountId}:launchtemplate/*

 無 無

請求參數

名稱

類型

必填

描述

樣本值
RegionId

string

是

地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。

cn-hangzhou
TemplateTag

array<object>

否

啟動範本自身的標籤對資訊。

說明

當前僅支援透過 API 建立和查詢啟動範本的標籤，控制台無法建立或查看。

object

否

啟動範本自身的標籤對資訊。

Key

string

否

啟動範本的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，則不允許為空字串。最多支援 128 個字元，不能以aliyun或acs:開頭，不能包含http://或https://。

TestKey
Value

string

否

啟動範本的標籤值。N 的取值範圍：1~20。一旦傳入該值，可以為空字串。最多支援 128 個字元，不能以aliyun或acs:開頭，不能包含http://或https://。

TestValue
RegionId

string

是

地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。

cn-hangzhou
LaunchTemplateName

string

是

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

testLaunchTemplateName
VersionDescription

string

否

執行個體啟動範本的版本描述。長度為 2~256 個英文或中文字元，不能以http://或https://開頭。

testVersionDescription
ImageId

string

否

映像 ID，啟動執行個體時選擇的映像資源。您可以透過 DescribeImages 查詢您可以使用的映像資源。

win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd
ImageOwnerAlias

string

否

映像來源。取值範圍：

  • system：阿里雲提供的公共映像。

  • self：您建立的自訂映像。

  • others：其他阿里雲使用者共用給您的映像。

  • marketplace：雲端市場提供的映像。您查詢到的雲端市場映像可以直接使用，無需提前訂閱。您需要自行留意雲端市場映像的收費詳情。

system
PasswordInherit

boolean

否

是否使用映像預設的密碼。

說明

使用該參數時，Password 參數必須為空，同時您需要確保使用的映像已經設置了密碼。

false
InstanceType

string

否

執行個體的資源規格。更多資訊，請參見執行個體規格族，也可以呼叫 DescribeInstanceTypes 介面獲得最新的規格表。

ecs.g5.large
SecurityGroupId

string

否

指定新建立執行個體所屬於的安全性群組 ID。同一個安全性群組內的執行個體之間可以互相存取，一個安全性群組最多能管理 1000 台執行個體。

說明

不支援同時指定SecurityGroupId和SecurityGroupIds.N。

sg-bp15ed6xe1yxeycg****
VpcId

string

否

專有網路 VPC ID。

vpc-bp12433upq1y5scen****
VSwitchId

string

否

建立 VPC 類型執行個體時需要指定虛擬交換器 ID。

vsw-bp1s5fnvk4gn2tws0****
InstanceName

string

否

執行個體名稱。長度為 2~128 個字元，支援 Unicode 中 letter 分類下的字元（其中包括英文、中文和數字等）。可以包含半形冒號（:）、底線（_）、半形句號（.）或者短劃線（-）。預設值為執行個體的InstanceId。

建立多台 ECS 執行個體時，您可以批次設置有序的執行個體名稱，並且可以包含方括號（[]）和逗號（,）。具體操作，請參見批次設置有序的執行個體名稱或主機名稱。

k8s-node-[1,4]-alibabacloud
Description

string

否

執行個體描述。長度為 2~256 個英文或中文字元，不能以http://或https://開頭。

testECSDescription
InternetMaxBandwidthIn

integer

否

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

  • 當所購公網出頻寬小於等於 10 Mbit/s 時：1~10，預設為 10。

  • 當所購公網出頻寬大於 10 Mbit/s 時：1~InternetMaxBandwidthOut的取值，預設為InternetMaxBandwidthOut的取值。

10
InternetMaxBandwidthOut

integer

否

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

10
HostName

string

否

雲端伺服器的主機名。

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

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

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

testHostName
ZoneId

string

否

執行個體所屬的可用區 ID。

cn-hangzhou-g
SystemDisk.Category

string

否

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

  • cloud：普通雲端硬碟。

  • cloud_efficiency：高效雲端硬碟。

  • cloud_ssd：SSD 雲端硬碟。

  • cloud_essd：ESSD 雲端硬碟。您可以透過參數SystemDisk.PerformanceLevel設置雲端硬碟的性能等級。

  • cloud_auto：ESSD AutoPL 雲端硬碟。

  • cloud_essd_entry：ESSD Entry 雲端硬碟。

已停售的執行個體規格且非 I/O 優化執行個體預設值為 cloud，否則預設值為 cloud_efficiency。

cloud_ssd
SystemDisk.Size

integer

否

系統磁碟大小，單位為 GiB。取值範圍：

  • cloud：20~500。

  • 其他雲端硬碟種類：20~2048。

該參數的取值必須大於或者等於 max{20, ImageSize}。

40
SystemDisk.DiskName

string

否

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

testSystemDiskName
SystemDisk.Description

string

否

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

testSystemDiskDescription
SystemDisk.Iops

integer

否

說明

該參數正在邀測中，暫未開放使用。

null
SystemDisk.PerformanceLevel

string

否

建立 ESSD 雲端硬碟作為系統磁碟使用時，設置雲端硬碟的性能等級。取值範圍：

  • PL0（預設）：單碟最高隨機讀寫 IOPS 1 萬。

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

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

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

有關如何選擇 ESSD 性能等級，請參見 ESSD 雲端硬碟。

PL0
SystemDisk.DeleteWithInstance

boolean

否

系統磁碟是否隨執行個體釋放。取值範圍：

  • true：隨執行個體釋放。

  • false：不隨執行個體釋放。

預設值：true。

true
SystemDisk.AutoSnapshotPolicyId

string

否

系統磁碟採用的自動快照策略 ID。

sp-gc7c37d4ylw7mtnk****
SystemDisk.ProvisionedIops

integer

否

ESSD AutoPL 雲端硬碟預配置讀寫 IOPS。取值範圍：0~min{50000, 1000*容量-基準性能}。

基準性能=min{1,800+50*容量, 50,000}

說明

當 DiskCategory 取值為 cloud_auto 時才支援設置該參數。更多資訊，請參見 ESSD AutoPL 雲端硬碟和修改 ESSD AutoPL 雲端硬碟預配置資訊。

50000
SystemDisk.BurstingEnabled

boolean

否

是否開啟 Burst（性能突發）。取值範圍：

  • true：是。

  • false：否。

true
IoOptimized

string

否

是否為 I/O 優化執行個體。取值範圍：

  • none：非 I/O 優化。

  • optimized：I/O 優化。

optimized
InstanceChargeType

string

否

執行個體的計費方式。取值範圍：

  • PrePaid：包年包月。選擇該類付費方式時，您必須確認自己的帳號支援信用支付，否則將返回InvalidPayMethod的錯誤提示。

  • PostPaid：隨用隨付。

PrePaid
Period

integer

否

購買資源的時長，單位為：月。當建立執行個體時，參數InstanceChargeType取值為PrePaid時該參數才生效且為必選值。取值範圍：1、2、3、4、5、6、7、8、9、12、24、36、48、60。

1
InternetChargeType

string

否

網路計費方式。取值範圍：

  • PayByBandwidth：按固定頻寬計費。

  • PayByTraffic：按使用流量計費。

說明

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

PayByTraffic
EnableVmOsConfig

boolean

否

是否啟用執行個體作業系統配置。

說明

該參數即將被棄用，為提高相容性，請盡量使用其他參數。

false
NetworkType

string

否

執行個體網路類型。取值範圍：

  • classic：經典網路。該功能已下線，詳情請參見下線公告。

  • vpc：專有網路 VPC。

vpc
UserData

string

否

執行個體自訂資料，需要以 Base64 方式編碼，原始資料最多為 32 KB。

ZWNobyBoZWxsbyBlY3Mh
KeyPairName

string

否

金鑰對名稱。

  • Windows 執行個體，忽略該參數。即使填寫了該參數，仍舊只執行Password的內容。

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

testKeyPairName
RamRoleName

string

否

執行個體 RAM 角色名稱。您可以使用 RAM API ListRoles 查詢您已建立的執行個體 RAM 角色。

testRamRoleName
AutoReleaseTime

string

否

自動釋放時間。按照 ISO 8601 標準表示，並需要使用 UTC 時間。格式為：yyyy-MM-ddTHH:mm:ssZ。

  • 如果秒（ss）取值不是00，則自動取為當前分鐘（mm）開始時。

  • 最短釋放時間為當前時間半小時之後。

  • 最長釋放時間不能超過當前時間三年。

2018-01-01T12:05:00Z
SpotStrategy

string

否

隨用隨付執行個體的搶佔策略。當參數InstanceChargeType取值為PostPaid時生效。取值範圍：

  • NoSpot：正常隨用隨付執行個體。

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

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

NoSpot
SpotPriceLimit

number

否

設置執行個體的每小時最高價格。支援最大 3 位小數，參數SpotStrategy取值為SpotWithPriceLimit時生效。

0.97
SpotDuration

integer

否

搶佔式執行個體的保留時長，單位為小時。預設值：1。取值範圍：

  • 1：建立後阿里雲會保證執行個體運行 1 小時不會被自動釋放；超過 1 小時後，系統會自動比較出價與市場價格、檢查資源庫存，來決定執行個體的持有和回收。

  • 0：建立後，阿里雲不保證執行個體運行 1 小時，系統會自動比較出價與市場價格、檢查資源庫存，來決定執行個體的持有和回收。

執行個體回收前 5 分鐘阿里雲會透過 ECS 系統事件向您傳送通知。搶佔式執行個體按秒計費，建議您結合具體任務執行耗時來選擇合適的保留時長。

說明

當 SpotStrategy 值為 SpotWithPriceLimit 或 SpotAsPriceGo 時該參數生效。

1
ResourceGroupId

string

否

執行個體、區塊儲存和彈性網卡所在的企業資源群組 ID。

rg-bp67acfmxazb4p****
TemplateResourceGroupId

string

否

啟動範本所在的企業資源群組 ID。

rg-bp67acfmxazb4p****
SecurityEnhancementStrategy

string

否

是否為作業系統開啟安全性加固。取值範圍：

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

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

Deactive
PrivateIpAddress

string

否

執行個體私網 IP 位址。

專有網路 VPC 類型 ECS 執行個體設置私網 IP 位址時，必須從虛擬交換器（VSwitchId）的空閒網段中選擇。

10.1.**.**
DeploymentSetId

string

否

部署集 ID。

ds-bp1brhwhoqinyjd6****
Ipv6AddressCount

integer

否

為主網卡指定隨機產生的 IPv6 位址數量。取值範圍為 1~10。

1
DataDisk

array<object>

否

資料磁碟資訊列表。

object

否

資料磁碟資訊列表。

PerformanceLevel

string

否

建立 ESSD 雲端硬碟作為資料磁碟使用時，設置雲端硬碟的性能等級。N 的取值必須和DataDisk.N.Category=cloud_essd中的 N 保持一致。取值範圍：

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

  • PL1（預設）：單碟最高隨機讀寫 IOPS 5 萬。

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

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

有關如何選擇 ESSD 性能等級，請參見 ESSD 雲端硬碟。

PL1
Description

string

否

資料磁碟描述。長度為 2~256 個英文或中文字元，不能以http://或https://開頭。

testDataDiskDescription
SnapshotId

string

否

建立資料磁碟 N 使用的快照。N 的取值範圍為 1~16。指定參數DataDisk.N.SnapshotId後，參數DataDisk.N.Size會被忽略，實際建立的雲端硬碟大小為指定的快照的大小。

說明

不能使用早於 2013 年 7 月 15 日（含）建立的快照，請求會報錯被拒絕。

s-bp17441ohwka0yuh****
Size

integer

否

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

  • cloud：5~2000

  • cloud_efficiency：20~32768

  • cloud_ssd：20~32768

  • cloud_essd：具體取值範圍與DataDisk.N.PerformanceLevel的取值有關。

    • PL0：1~32768。

    • PL1：20~32768。

    • PL2：461~32768。

    • PL3：1261~32768。

  • cloud_auto：1~32,768。

  • cloud_essd_entry：10~32,768。

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

2000
Device

string

否

資料磁碟的掛載點。掛載的資料磁碟數量不同，掛載點的命名不同：

  • 1~25 塊資料磁碟：/dev/xvd[b-z]

  • 大於 25 塊資料磁碟：/dev/xvd[aa-zz]，例如第 26 塊資料磁碟會被命名為 /dev/xvdaa，第 27 塊資料磁碟為 /dev/xvdab，以此類推。

說明

該參數僅用於全映像（整機映像）場景。您可以透過將此參數設置為全映像中資料磁碟對應的掛載點，並修改對應的DataDisk.N.Size和DataDisk.N.Category參數，達到修改全映像中資料磁碟磁碟種類和大小的目的。

/dev/xvdb

DiskName

string

否

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

testDataDiskName
Category

string

否

資料磁碟 N 的雲端硬碟種類。取值範圍：

  • cloud_efficiency：高效雲端硬碟。

  • cloud_ssd：SSD 雲端硬碟。

  • cloud_essd：ESSD 雲端硬碟。

  • cloud：普通雲端硬碟。

  • cloud_auto：ESSD AutoPL 雲端硬碟。

  • cloud_regional_disk_auto：ESSD 同城冗餘雲端硬碟。

  • cloud_essd_entry：ESSD Entry 雲端硬碟。
    說明

    僅當InstanceType設置為ecs.u1或ecs.e規格族時，該參數支援cloud_essd_entry。

  • elastic_ephemeral_disk_standard：彈性臨時碟-標準版。

  • elastic_ephemeral_disk_premium：彈性臨時碟-進階版。

對於 I/O 優化執行個體，預設值為 cloud_efficiency。對於非 I/O 優化執行個體，預設值為 cloud。 參數預設值說明：

  • 當 InstanceType 為已停售且非 I/O 優化的執行個體規格，該參數預設值為cloud。

  • 其它情況下，該參數預設值為cloud_efficiency。

cloud_ssd
DeleteWithInstance

boolean

否

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

  • true：隨執行個體釋放。

  • false：不隨執行個體釋放。

預設值：true。

true
Encrypted

string

否

資料磁碟是否加密。

false
AutoSnapshotPolicyId

string

否

資料磁碟採用的自動快照策略 ID。

sp-m5e7fa9ute44ssa****
ProvisionedIops

integer

否

ESSD AutoPL 雲端硬碟預配置讀寫 IOPS。取值範圍：0~min{50000, 1000*容量-基準性能}。

基準性能=min{1,800+50*容量, 50,000}

說明

當 DiskCategory 取值為 cloud_auto 時才支援設置該參數。更多資訊，請參見 ESSD AutoPL 雲端硬碟和修改 ESSD AutoPL 雲端硬碟預配置資訊。

50000
BurstingEnabled

boolean

否

是否開啟 Burst（性能突發）。取值範圍：

  • true：是。

  • false：否。

true
KMSKeyId

string

否

資料磁碟對應的 KMS 密鑰 ID。

0e478b7a-4262-4802-b8cb-00d****
NetworkInterface

array<object>

否

彈性網卡資訊。

object

否

彈性網卡資訊。

VSwitchId

string

否

彈性網卡所屬的虛擬交換器 ID。

您需要注意：

  • N 的取值範圍為 1~2，設置 1 個彈性網卡時，支援設置 1 個主網卡或 1 個輔助網卡；設置 2 個彈性網卡時，僅支援同時設置 1 個主網卡和 1 個輔助網卡。

  • 如果NetworkInterface.N.InstanceType取值為Primary，則必須設置該參數。此時該參數的作用等同於VSwitchId，但需要注意不能同時設置VSwitchId參數。

  • 如果NetworkInterface.N.InstanceType取值為Secondary或空值，則該參數為非必填參數。預設值為 ECS 執行個體所屬的虛擬交換器。

vsw-bp1s5fnvk4gn2tws0****
NetworkInterfaceName

string

否

彈性網卡名稱。

您需要注意：

  • N 的取值範圍為 1~2，設置 1 個彈性網卡時，支援設置 1 個主網卡或 1 個輔助網卡；設置 2 個彈性網卡時，僅支援同時設置 1 個主網卡和 1 個輔助網卡。

  • 如果NetworkInterface.N.InstanceType取值為Primary，則無需設置該參數。

testEniName
Description

string

否

輔助彈性網卡描述資訊。長度為 2~256 個英文或中文字元，不能以http://或https://開頭。NetworkInterface.N的 N 取值不能大於 1。

testEniDescription
SecurityGroupId

string

否

彈性網卡所屬的安全性群組 ID。

您需要注意：

  • N 的取值範圍為 1~2，設置 1 個彈性網卡時，支援設置 1 個主網卡或 1 個輔助網卡；設置 2 個彈性網卡時，僅支援同時設置 1 個主網卡和 1 個輔助網卡。

  • 如果NetworkInterface.N.InstanceType取值為Primary，則必須設置該參數。此時該參數的作用等同於SecurityGroupId，但需要注意不能再設置SecurityGroupId、SecurityGroupIds.N或NetworkInterface.N.SecurityGroupIds.N。

  • 如果NetworkInterface.N.InstanceType取值為Secondary或空值，則該參數為非必填參數。預設值為 ECS 執行個體所屬的安全性群組。

sg-bp15ed6xe1yxeycg****
PrimaryIpAddress

string

否

新增一張彈性網卡並設置主 IP 位址。

您需要注意：

  • N 的取值範圍為 1~2：

    • 設置 1 個彈性網卡時，支援設置 1 個主網卡或 1 個輔助網卡。如果Amount參數取值大於 1，且設置了主網卡並設置了該參數，則表示在批次建立 ECS 執行個體時，以指定的主 IP 位址為起始位址，依次為多台 ECS 執行個體分配連續的主 IP 位址，但需要注意，此時不支援再為執行個體繫結輔助網卡 CreateNetworkInterface AttachNetworkInterface

192.168.**.**
SecurityGroupIds

array

否

彈性網卡所屬的一個或多個安全性群組 ID。

  • 第一個 N 的取值範圍為 1~2，設置 1 個彈性網卡時，支援設置 1 個主網卡或 1 個輔助網卡；設置 2 個彈性網卡時，僅支援同時設置 1 個主網卡和 1 個輔助網卡。

  • 第二個 N 表示可以指定一個或多個安全性群組 ID。N 的取值範圍與執行個體能夠加入安全性群組配額有關，更多資訊，請參見安全性群組限制。

您需要注意：

  • 如果NetworkInterface.N.InstanceType取值為Primary，則必須設置該參數或NetworkInterface.N.SecurityGroupId。此時該參數的作用等同於SecurityGroupIds.N，但需要注意不能再設置SecurityGroupId、SecurityGroupIds.N或NetworkInterface.N.SecurityGroupId。

  • 如果NetworkInterface.N.InstanceType取值為Secondary或空值，則該參數為非必填參數。預設值為 ECS 執行個體所屬的安全性群組。

sg-bp67acfmxazb4p****

string

否

彈性網卡所屬的一個或多個安全性群組 ID。

  • 第一個 N 的取值範圍為 1~2，設置 1 個彈性網卡時，支援設置 1 個主網卡或 1 個輔助網卡；設置 2 個彈性網卡時，僅支援同時設置 1 個主網卡和 1 個輔助網卡。

  • 第二個 N 表示可以指定一個或多個安全性群組 ID。N 的取值範圍與執行個體能夠加入安全性群組配額有關，更多資訊，請參見安全性群組限制。

您需要注意：

  • 如果NetworkInterface.N.InstanceType取值為Primary，則必須設置該參數或NetworkInterface.N.SecurityGroupId。此時該參數的作用等同於SecurityGroupIds.N，但需要注意不能再設置SecurityGroupId、SecurityGroupIds.N或NetworkInterface.N.SecurityGroupId。

  • 如果NetworkInterface.N.InstanceType取值為Secondary或空值，則該參數為非必填參數。預設值為 ECS 執行個體所屬的安全性群組。

sg-bp67acfmxazb4p****
InstanceType

string

否

彈性網卡類型。N 的取值範圍為 1~2，設置 1 個彈性網卡時，支援設置 1 個主網卡或 1 個輔助網卡；設置 2 個彈性網卡時，僅支援同時設置 1 個主網卡和 1 個輔助網卡。

參數取值範圍：

  • Primary：主網卡。

  • Secondary：輔助網卡。

預設值：Secondary。

Secondary
NetworkInterfaceTrafficMode

string

否

主網卡的通訊模式。參數取值範圍：

  • Standard：使用 TCP 通訊模式。

  • HighPerformance：開啟 ERI（Elastic RDMA Interface）介面，使用 RDMA 通訊模式。

Standard
DeleteOnRelease

boolean

否

釋放執行個體時是否保留網卡。取值範圍：

  • true：不保留。

  • false：保留。

預設值：true。

說明

該參數只對輔助網卡生效。

true
Tag

array<object>

否

透過該範本的版本建立的執行個體、雲端硬碟和主網卡的標籤資訊。

使用場景

透過呼叫 CreateLa

object

否

通过该模板的版本创建的实例、云盘和主网卡的标签信息。

Key

string

否

通过该模板的版本创建的实例、云盘和主网卡的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或 https://。

TestKey
Value

string

否

通过该模板的版本创建的实例、云盘和主网卡的标签值。N 的取值范围：1~20。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能包含 http://或者 https://。

TestValue
SecurityGroupIds

array

否

实例加入的一个或多个安全组。N 的取值范围与实例能够加入安全组配额有关，更多信息，请参见使用限制。

說明

不支持同时指定SecurityGroupId和SecurityGroupIds.N。

sg-bp15ed6xe1yxeycg7****

string

否

实例加入的一个或多个安全组。N 的取值范围与实例能够加入安全组配额有关，更多信息，请参见使用限制。

說明

不支持同时指定SecurityGroupId和SecurityGroupIds.N。

sg-bp15ed6xe1yxeycg7****
SystemDisk.Encrypted

string

否

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

  • true：加密。

  • false：不加密。

默认值：false。

說明

中国香港 D 可用区、新加坡 A 可用区暂不支持在创建实例时加密系统盘。

false
DeletionProtection

boolean

否

实例释放保护属性，指定是否支持通过控制台或 API（ DeleteInstance ）释放实例。取值范围：

  • true：开启实例释放保护。

  • false：关闭实例释放保护。

默认值：false。

說明

该属性仅适用于按量付费实例，且只能限制手动释放操作，对系统释放操作不生效。

false
CreditSpecification

string

否

设置突发性能实例的运行模式。取值范围：

Standard
AutoRenew

boolean

否

是否要自动续费。取值范围：

  • true：自动续费。

  • false：不自动续费。

默认值：false。

說明

当参数InstanceChargeType取值PrePaid时才生效。

true
AutoRenewPeriod

integer

否

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

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

默认值：1。

1
PeriodUnit

string

否

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

Month（默认）。

Month
HttpEndpoint

string

否

是否启用实例元数据的访问通道。取值范围：

  • enabled：启用。

  • disabled：禁用。

默认值：enabled。

說明

有关实例元数据的信息，请参见实例元数据概述。

enabled
HttpTokens

string

否

访问实例元数据时是否强制使用加固模式（IMDSv2）。取值范围：

  • optional：不强制使用。

  • required：强制使用。设置该取值后，普通模式无法访问实例元数据。

默认值：optional。

說明

有关访问实例元数据的模式，请参见实例元数据概述。

optional
HttpPutResponseHopLimit

integer

否

說明

该参数暂未开放使用。

3
SystemDisk.KMSKeyId

string

否

系统盘对应的 KMS 密钥 ID。

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

object

否

镜像相关属性信息。

LoginAsNonRoot

boolean

否

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

  • true：是。

  • false：否。

false
SecurityOptions

object

否

安全选项。

TrustedSystemMode

string

否

可信系统模式。取值：vTPM。

目前，可信系统模式支持的实例规格族：

  • g7、c7、r7。

  • 安全增强型（g7t、c7t、r7t）。

当您创建以上实例规格族的 ECS 实例时，需要设置该参数。具体说明如下：

  • 如果您使用阿里云可信系统，请将该参数值设置为 vTPM，在实例启动时即可通过阿里云可信系统完成可信校验。

  • 如果您不使用阿里云可信系统，可以不设置该参数值，但您需要注意，如果您所创建的 ECS 实例使用了 Enclave 机密计算模式（SecurityOptions.ConfidentialComputingMode=Enclave），则该 ECS 实例也会启用可信系统。

  • 通过 OpenAPI 创建可信系统的 ECS 实例时，只能调用RunInstances实现，CreateInstance目前不支持设置SecurityOptions.TrustedSystemMode参数。

說明

如果您在创建实例的时候指定其为可信实例，那么当您更换系统盘时只能使用支持可信系统的镜像。

关于可信系统的更多信息，请参见安全增强型实例可信功能概述。

vTPM

返回參數

名稱

類型

描述

樣本值

object

LaunchTemplateId

string

实例启动模板 ID。

lt-m5eiaupmvm2op9d****
RequestId

string

請求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
LaunchTemplateVersionNumber

integer

实例启动模板版本号。

20

樣本

正常返回樣本

JSON格式

{
  "LaunchTemplateId": "lt-m5eiaupmvm2op9d****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "LaunchTemplateVersionNumber": 20
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述
400 InvalidRegion.NotExist %s
400 MissingParameter %s
400 InvalidParameter %s
400 InvalidLaunchTemplateName.Malformed The specified parameter LaunchTemplateName is not valid.
400 InvalidDescription.Malformed The specified parameter "VersionDescription" is not valid.
400 InvalidUserData.SizeExceeded %s
400 InvalidUserData.Base64FormatInvalid %s
400 Duplicate.TagKey The Tag.N.Key contain duplicate key.
400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid.
400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid.
400 InvalidHostName.Malformed The specified parameter "HostName" is not valid.
400 InvalidParams.CreateEniParams %s
500 InternalError The request processing has failed due to some unknown error.
403 LaunchTemplateLimitExceed %s
403 LaunchTemplateName.Duplicated %s
403 QuotaExceed.Tags %s
404 InvalidResourceGroup.NotFound The ResourceGroup provided does not exist in our records.

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

變更歷史

更多資訊，參考變更詳情。

上一篇：啟動模板下一篇：DescribeLaunchTemplates