建立一個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程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:CreateLaunchTemplate |
create |
*LaunchTemplate
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
地域 ID。您可以呼叫 DescribeRegions 檢視最新的阿里雲地域清單。 |
cn-hangzhou |
| TemplateTag |
array<object> |
否 |
啟動範本自身的標籤對資訊。 說明
當前僅支援透過 API 建立和查詢啟動範本的標籤,控制台無法建立或檢視。 |
|
|
object |
否 |
啟動範本自身的標籤對資訊。 |
||
| Key |
string |
否 |
啟動範本的標籤鍵。N 的取值範圍:1~20。一旦傳入該值,則不允許為空字串。最多支援 128 個字元,不能以 |
TestKey |
| Value |
string |
否 |
啟動範本的標籤值。N 的取值範圍:1~20。一旦傳入該值,可以為空字串。最多支援 128 個字元,不能以 |
TestValue |
| RegionId |
string |
是 |
執行個體啟動範本名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以 |
testLaunchTemplateName |
| LaunchTemplateName |
string |
是 |
執行個體啟動範本的版本描述。長度為 2~256 個英文或中文字元,不能以 |
testVersionDescription |
| VersionDescription |
string |
否 |
映像 ID,啟動執行個體時選擇的映像資源。您可以透過 DescribeImages 查詢您可以使用的映像資源。 |
win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd |
| ImageId |
string |
否 |
映像來源。取值範圍:
|
system |
| ImageOwnerAlias |
string |
否 |
是否使用映像預設的密碼。 說明
使用該參數時,Password 參數必須為空,同時您需要確保使用的映像已經設定了密碼。 |
false |
| PasswordInherit |
boolean |
否 |
執行個體的資源規格。更多資訊,請參見執行個體規格族,也可以呼叫 DescribeInstanceTypes 介面獲得最新的規格表。 |
ecs.g5.large |
| InstanceType |
string |
否 |
指定新建立執行個體所屬於的安全性群組 ID。同一個安全性群組內的執行個體之間可以互相存取,一個安全性群組最多能管理 1000 台執行個體。 說明
不支援同時指定 |
sg-bp15ed6xe1yxeycg**** |
| SecurityGroupId |
string |
否 |
專用網路 VPC ID。 |
vpc-bp12433upq1y5scen**** |
| VpcId |
string |
否 |
建立 VPC 類型執行個體時需要指定虛擬交換器 ID。 |
vsw-bp1s5fnvk4gn2tws0**** |
| VSwitchId |
string |
否 |
執行個體名稱。長度為 2~128 個字元,支援 Unicode 中 letter 分類下的字元(其中包括英文、中文和數字等)。可以包含半形冒號(:)、底線(_)、半形句號(.)或者短劃線(-)。預設值為執行個體的 建立多台 ECS 執行個體時,您可以批次設定有序的執行個體名稱,並且可以包含方括號([])和逗號(,)。具體操作,請參見批次設定有序的執行個體名稱或主機名稱。 |
k8s-node-[1,4]-alibabacloud |
| InstanceName |
string |
否 |
執行個體描述。長度為 2~256 個英文或中文字元,不能以 |
testECSDescription |
| Description |
string |
否 |
公網入頻寬最大值,單位為 Mbit/s。取值範圍:
|
10 |
| InternetMaxBandwidthIn |
integer |
否 |
公網出頻寬最大值,單位為 Mbit/s。取值範圍為 0~100。 |
10 |
| InternetMaxBandwidthOut |
integer |
否 |
雲端伺服器的主機名稱。
|
testHostName |
| HostName |
string |
否 |
執行個體所屬的可用區 ID。 |
cn-hangzhou-g |
| ZoneId |
string |
否 |
系統磁碟的雲端硬碟種類。取值範圍:
已停售的執行個體規格且非 I/O 最佳化執行個體預設值為 cloud,否則預設值為 cloud_efficiency。 |
cloud_ssd |
| SystemDisk.Category |
string |
否 |
系統磁碟大小,單位為 GiB。取值範圍:
該參數的取值必須大於或者等於 max{20, ImageSize}。 |
40 |
| SystemDisk.Size |
integer |
否 |
系統磁碟名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以 |
testSystemDiskName |
| SystemDisk.DiskName |
string |
否 |
系統磁碟描述。長度為 2~256 個英文或中文字元,不能以 |
testSystemDiskDescription |
| SystemDisk.Description |
string |
否 |
說明
該參數正在邀測中,暫未開放使用。 |
null |
| SystemDisk.Iops |
integer |
否 |
建立 ESSD 雲端硬碟作為系統磁碟使用時,設定雲端硬碟的效能等級。取值範圍:
有關如何選擇 ESSD 效能等級,請參見 ESSD 雲端硬碟。 |
PL0 |
| SystemDisk.PerformanceLevel |
string |
否 |
系統磁碟是否隨執行個體釋放。取值範圍:
預設值:true。 |
true |
| SystemDisk.DeleteWithInstance |
boolean |
否 |
系統磁碟採用的自動快照策略 ID。 |
sp-gc7c37d4ylw7mtnk**** |
| SystemDisk.AutoSnapshotPolicyId |
string |
否 |
ESSD AutoPL 雲端硬碟預配置讀寫 IOPS。取值範圍:0~min{50000, 1000*容量-基準效能}。 基準效能=min{1,800+50*容量, 50,000} 說明
當 DiskCategory 取值為 cloud_auto 時才支援設定該參數。更多資訊,請參見ESSD AutoPL 雲端硬碟和修改 ESSD AutoPL 雲端硬碟預配置資訊。 |
50000 |
| SystemDisk.ProvisionedIops |
integer |
否 |
是否開啟 Burst(效能突發)。取值範圍:
|
true |
| SystemDisk.BurstingEnabled |
boolean |
否 |
是否為 I/O 最佳化執行個體。取值範圍:
|
optimized |
| IoOptimized |
string |
否 |
執行個體的計費方式。取值範圍:
|
PrePaid |
| InstanceChargeType |
string |
否 |
購買資源的時長,單位為:月。當建立執行個體時,參數 |
1 |
| Period |
integer |
否 |
網路計費方式。取值範圍:
說明
按使用流量計費模式下的出入頻寬峰值都是頻寬上限,不作為業務承諾指標。當出現資源爭搶時,頻寬峰值可能會受到限制。如果您的業務需要有頻寬的保障,請使用按固定頻寬計費模式。 |
PayByTraffic |
| InternetChargeType |
string |
否 |
是否啟用執行個體作業系統設定。 說明
該參數即將被棄用,為提高相容性,請盡量使用其他參數。 |
false |
| EnableVmOsConfig |
boolean |
否 |
執行個體網路類型。取值範圍:
|
vpc |
| NetworkType |
string |
否 |
執行個體自訂資料,需要以 Base64 方式編碼,原始資料最多為 32 KB。 |
ZWNobyBoZWxsbyBlY3Mh |
| UserData |
string |
否 |
金鑰對名稱。
|
testKeyPairName |
| KeyPairName |
string |
否 |
執行個體 RAM 角色名稱。您可以使用 RAM API ListRoles 查詢您已建立的執行個體 RAM 角色。 |
testRamRoleName |
| RamRoleName |
string |
否 |
自動釋放時間。按照ISO 8601標準表示,並需要使用 UTC 時間。格式為:yyyy-MM-ddTHH:mm:ssZ。
|
2018-01-01T12:05:00Z |
| AutoReleaseTime |
string |
否 |
按量執行個體的搶佔策略。當參數
|
NoSpot |
| SpotStrategy |
string |
否 |
設定執行個體的每小時最高價格。支援最大 3 位小數,參數 |
0.97 |
| SpotPriceLimit |
number |
否 |
搶佔式執行個體的保留時長,單位為小時。 預設值:1。取值範圍:
執行個體回收前 5 分鐘阿里雲會透過 ECS 系統事件向您發送通知。搶佔式執行個體按秒計費,建議您結合具體任務執行耗時來選擇合適的保留時長。 說明
當 SpotStrategy 值為 SpotWithPriceLimit 或 SpotAsPriceGo 時該參數生效。 |
1 |
| SpotDuration |
integer |
否 |
執行個體、區塊儲存和彈性網卡所在的企業資源群組 ID。 |
rg-bp67acfmxazb4p**** |
| ResourceGroupId |
string |
否 |
啟動範本所在的企業資源群組 ID。 |
rg-bp67acfmxazb4p**** |
| TemplateResourceGroupId |
string |
否 |
是否為作業系統啟用安全性加固。取值範圍:
|
Deactive |
| SecurityEnhancementStrategy |
string |
否 |
執行個體私網 IP 位址。 專用網路 VPC 類型 ECS 執行個體設定私網 IP 位址時,必須從虛擬交換器( |
10.1.**.** |
| PrivateIpAddress |
string |
否 |
部署集 ID。 |
ds-bp1brhwhoqinyjd6**** |
| DeploymentSetId |
string |
否 |
為主網卡指定隨機產生的 IPv6 位址數量。取值範圍為 1~10。 |
1 |
| Ipv6AddressCount |
integer |
否 |
資料磁碟資訊清單。 |
1 |
| DataDisk |
array<object> |
否 |
彈性網卡資訊。 |
|
|
object |
否 |
彈性網卡資訊。 |
||
| PerformanceLevel |
string |
否 |
建立 ESSD 雲端硬碟作為資料磁碟使用時,設定雲端硬碟的效能等級。N 的取值必須和
有關如何選擇 ESSD 效能等級,請參見 ESSD 雲端硬碟。 |
PL1 |
| Description |
string |
否 |
輔助彈性網卡描述資訊。長度為 2~256 個英文或中文字元,不能以 |
testEniDescription |
| SnapshotId |
string |
否 |
建立資料磁碟 N 使用的快照。N 的取值範圍為 1~16。指定參數 說明
不能使用早於 2013 年 7 月 15 日(含)建立的快照,請求會報錯被拒絕。 |
s-bp17441ohwka0yuh**** |
| Size |
integer |
否 |
第 N 個資料磁碟的容量大小,N 的取值範圍為 1~16,記憶體單位為 GiB。取值範圍:
該參數的取值必須大於等於參數 |
2000 |
| Device |
string |
否 |
資料磁碟的掛載點。掛載的資料磁碟數量不同,掛載點的命名不同:
說明
該參數僅用於全映像(整機映像)場景。您可以透過將此參數設定為全映像中資料磁碟對應的掛載點,並修改對應的 |
/dev/xvdb |
| DiskName |
string |
否 |
資料磁碟名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以 |
testDataDiskName |
| Category |
string |
否 |
資料磁碟 N 的雲端硬碟種類。取值範圍:
對於 I/O 最佳化執行個體,預設值為 cloud_efficiency。對於非 I/O 最佳化執行個體,預設值為 cloud。 參數預設值說明:
|
cloud_ssd |
| DeleteWithInstance |
boolean |
否 |
表示資料磁碟是否隨執行個體釋放。取值範圍:
預設值: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 |
| KMSKeyId |
string |
否 |
資料磁碟對應的 KMS 金鑰 ID。 |
0e478b7a-4262-4802-b8cb-00d**** |
| NetworkInterface |
array<object> |
否 |
透過該範本的版本建立的執行個體、雲端硬碟和主網卡的標籤資訊。 |
|
|
object |
否 |
透過該範本的版本建立的執行個體、雲端硬碟和主網卡的標籤資訊。 |
||
| VSwitchId |
string |
否 |
彈性網卡所屬的虛擬交換器 ID。 您需要注意:
|
vsw-bp1s5fnvk4gn2tws0**** |
| NetworkInterfaceName |
string |
否 |
彈性網卡名稱。 您需要注意:
|
testEniName |
| Description |
string |
否 |
輔助彈性網卡描述資訊。長度為 2~256 個英文或中文字元,不能以 |
testEniDescription |
| SecurityGroupId |
string |
否 |
彈性網卡所屬的安全性群組 ID。 您需要注意:
|
sg-bp15ed6xe1yxeycg**** |
| PrimaryIpAddress |
string |
否 |
新增一張彈性網卡並設定主 IP 地址。 您需要注意:
說明
建立 ECS 執行個體時,您最多能新增一張輔助網卡。執行個體建立成功後,您可以呼叫 CreateNetworkInterface 和 AttachNetworkInterface 新增更多的輔助網卡。 |
192.168.**.** |
| SecurityGroupIds |
array |
否 |
彈性網卡所屬的一個或多個安全性群組 ID。
您需要注意:
|
sg-bp67acfmxazb4p**** |
|
string |
否 |
彈性網卡所屬的一個或多個安全性群組 ID。
您需要注意:
|
sg-bp67acfmxazb4p**** |
|
| InstanceType |
string |
否 |
彈性網卡類型。N 的取值範圍為 1~2,設定 1 個彈性網卡時,支援設定 1 個主網卡或 1 個輔助網卡;設定 2 個彈性網卡時,僅支援同時設定 1 個主網卡和 1 個輔助網卡。 參數取值範圍:
預設值:Secondary。 |
Secondary |
| NetworkInterfaceTrafficMode |
string |
否 |
主網卡的通訊模式。參數取值範圍:
|
Standard |
| DeleteOnRelease |
boolean |
否 |
釋放執行個體時是否保留網卡。取值範圍:
預設值:true。 說明
該參數只對輔助網卡生效。 |
true |
| Tag |
array<object> |
否 |
執行個體加入的一個或多個安全性群組。N 的取值範圍與執行個體能夠加入安全性群組配額有關,更多資訊,請參見使用限制。 說明
不支援同時指定 |
sg-bp15ed6xe1yxeycg7**** |
|
object |
否 |
執行個體加入的一個或多個安全性群組。N 的取值範圍與執行個體能夠加入安全性群組配額有關,更多資訊,請參見使用限制。 說明
不支援同時指定 |
sg-bp15ed6xe1yxeycg7**** |
|
| Key |
string |
否 |
透過該範本的版本建立的執行個體、雲端硬碟和主網卡的標籤鍵。N 的取值範圍:1~20。一旦傳入該值,則不允許為空字串。最多支援 128 個字元,不能以 aliyun 和 acs: 開頭,不能包含 http:// 或 https://。 |
TestKey |
| Value |
string |
否 |
透過該範本的版本建立的執行個體、雲端硬碟和主網卡的標籤值。N 的取值範圍:1~20。一旦傳入該值,可以為空字串。最多支援 128 個字元,不能包含 http:// 或者 https://。 |
TestValue |
| SecurityGroupIds |
array |
否 |
系統磁碟是否加密。取值範圍:
預設值:false。 說明
中國香港 D 可用區、新加坡 A 可用區暫不支援在建立執行個體時加密系統磁碟。 |
false |
|
string |
否 |
執行個體加入的一個或多個安全性群組。N 的取值範圍與執行個體能夠加入安全性群組配額有關,更多資訊,請參見使用限制。 說明
不支援同時指定 |
sg-bp15ed6xe1yxeycg7**** |
|
| SystemDisk.Encrypted |
string |
否 |
執行個體釋放保護屬性,指定是否支援透過控制台或 API( DeleteInstance )釋放執行個體。取值範圍:
預設值:false。 說明
該屬性僅適用於按量計費執行個體,且只能限制手動釋放操作,對系統釋放操作不生效。 |
false |
| DeletionProtection |
boolean |
否 |
設定突發效能執行個體的運作模式。取值範圍:
|
Standard |
| CreditSpecification |
string |
否 |
是否要自動續費。取值範圍:
預設值:false。 說明
當參數 |
true |
| AutoRenew |
boolean |
否 |
單次自動續費的續費時長。取值範圍: PeriodUnit=Month 時:1、2、3、6、12、24、36、48、60。 預設值:1。 |
1 |
| AutoRenewPeriod |
integer |
否 |
包年包月計費方式的時長單位。取值範圍: Month(預設)。 |
Month |
| PeriodUnit |
string |
否 |
是否啟用執行個體中繼資料的存取通道。取值範圍:
預設值:enabled。 說明
有關執行個體中繼資料的資訊,請參見執行個體中繼資料概述。 |
enabled |
| HttpEndpoint |
string |
否 |
存取執行個體中繼資料時是否強制使用加固模式(IMDSv2)。取值範圍:
預設值:optional。 說明
有關存取執行個體中繼資料的模式,請參見執行個體中繼資料概述。 |
optional |
| HttpTokens |
string |
否 |
說明
該參數暫未開放使用。 |
3 |
| HttpPutResponseHopLimit |
integer |
否 |
系統磁碟對應的 KMS 金鑰 ID。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| SystemDisk.KMSKeyId |
string |
否 |
映像相關屬性資訊。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| ImageOptions |
object |
否 |
安全選項。 |
|
| LoginAsNonRoot |
boolean |
否 |
使用該映像的執行個體是否支援使用 ecs-user 使用者登入。 可能值:
|
false |
| SecurityOptions |
object |
否 |
安全選項。 |
|
| TrustedSystemMode |
string |
否 |
可信系統模式。取值:vTPM。 目前,可信系統模式支援的執行個體規格族:
當您建立以上執行個體規格族的 ECS 執行個體時,需要設定該參數。具體說明如下:
說明
如果您在建立執行個體的時候指定其為可信執行個體,那麼當您更換系統磁碟時只能使用支援可信系統的映像。 關於可信系統的更多資訊,請參見安全增強型執行個體可信功能概述。 |
vTPM |
| EnableSecureBoot |
boolean |
否 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
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. | 指定的參數 LaunchTemplateName 無效。 |
| 400 | InvalidDescription.Malformed | The specified parameter "VersionDescription" is not valid. | |
| 400 | InvalidUserData.SizeExceeded | %s | 您設定的資料大小超過了允許的最大值。 |
| 400 | InvalidUserData.Base64FormatInvalid | %s | 指定的參數 UserData 必須是 base64 編碼的。 |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 標籤中存在重複的鍵,請保持鍵的唯一性。 |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定的標籤鍵無效。標籤鍵不能為空或 null,最多支援 128 個字元,不能以「aliyun」或「acs:」開頭,不能包含「http://」或「https://」。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定的標籤值無效。標籤值最多支援 128 個字元,並且不能包含「http://」或「https://」。 |
| 400 | InvalidHostName.Malformed | The specified parameter "HostName" is not valid. | 指定的參數 HostName 不合法。 |
| 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 | 標籤參數的配額已超過,最大值為:20。 |
| 403 | InvalidOperation.InstanceTypeSecureBootUnsupported | The instance type does not support secure boot. | 執行個體規格不支援安全啟動。 |
| 403 | InvalidOperation.SecureBootRegionNotSupported | Secure Boot is not available in the specified region. | 目前地域不支援開啟執行個體安全啟動。 |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | 找不到對應的資源群組。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。