調用CreateLaunchTemplate建立一個執行個體啟動模板,簡稱模板。執行個體啟動模板能免除您每次建立執行個體時都需要填入大量配置參數。

介面說明

執行個體啟動模板中包含用於建立執行個體的相關配置,例如執行個體所屬地區、鏡像ID、執行個體規格、安全性群組ID和公網頻寬等。如果模板中沒有指定某一執行個體配置,您需要在建立執行個體時為執行個體指定該配置。建立模板(CreateLaunchTemplate)後,模板的初始版本為1,您可以後續基於該版本建立多個模板版本(CreateLaunchTemplateVersion),版本號碼從1開始順序遞增。如果您在建立執行個體(RunInstances)時不指定模板版本號碼,會採用預設版本。

調用該介面時,您需要注意:

  • 您最多能在一個地區內建立30個執行個體啟動模板,且每個模板最多能有30個版本。
  • 執行個體啟動模板的參數大多數為選擇性參數。建立模板時,我們不會驗證模板中參數取值的存在性和有效性。只會在真正建立執行個體時校正參數取值的有效性。
  • 如果執行個體啟動模板中設定了某一配置,建立執行個體(RunInstances)時就無法過濾掉該配置。例如,如果模板設定了HostName=LocalHostRunInstancesHostName取值為空白時,執行個體的主機名稱依然是LocalHost。如果您想覆蓋HostName=LocalHost這一配置,可以在RunInstances中取HostName=MyHost或其他參數值。

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
LaunchTemplateName String JoshuaWinPrePaid

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

RegionId String cn-hangzhou

地區ID。您可以調用DescribeRegions查看最新的阿里雲地區列表。

Action String CreateLaunchTemplate

系統規定參數。取值:CreateLaunchTemplate

AutoReleaseTime String 2018-01-01T12:05:00Z

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

  • 如果秒(ss)取值不是00,則自動取為當前分鐘(mm)開始時。
  • 最短釋放時間為目前時間半小時之後。
  • 最長釋放時間不能超過目前時間三年。
DataDisk.N.Category String cloud_ssd

資料盤n的雲端硬碟種類。取值範圍:

  • cloud:普通雲端硬碟
  • cloud_efficiency:高效雲端硬碟
  • cloud_ssd:SSD雲端硬碟
  • cloud_essd:ESSD雲端硬碟
DataDisk.N.DeleteWithInstance Boolean true

表示資料盤是否隨執行個體釋放。

DataDisk.N.Description String FinanceDept

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

DataDisk.N.DiskName String cloud_ssdData

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

DataDisk.N.Encrypted String false

資料盤n是否加密。

DataDisk.N.Size Integer 2000

第n個資料盤的容量大小,n的取值範圍為1~16,記憶體單位為GiB。取值範圍:

  • cloud:5~2000
  • cloud_efficiency:20~32768
  • cloud_ssd:20~32768
  • cloud_essd:20~32768

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

DataDisk.N.SnapshotId String s-bp17441ohwka0yuhx***

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

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

Description String FinaceDept

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

EnableVmOsConfig Boolean false

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

说明 該參數即將被棄用,為提高相容性,請盡量使用其他參數。
HostName String JoshuaHost

雲端服務器的主機名稱。

  • 點號(.)和虛線(-)不能作為首尾字元,更不能連續使用。
  • Windows執行個體:字元長度為2~15,不支援點號(.),不能全是數字。允許大小寫英文字母、數字和虛線(-)。
  • 其他類型執行個體(Linux 等):字元長度為2~64,支援多個點號(.),點之間為一段,每段允許大小寫英文字母、數字和虛線(-)。
ImageId String win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd

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

ImageOwnerAlias String system

鏡像來源。取值範圍:

  • system:阿里雲提供的公用鏡像。
  • self:您建立的自訂鏡像。
  • others:其他阿里雲使用者共用給您的鏡像。
  • marketplace:雲市場提供的鏡像。您查詢到的雲市場鏡像可以直接使用,無需提前訂閱。您需要自行留意雲市場鏡像的收費詳情。

預設值:空,空表示返回取值為system、self以及others的結果。

InstanceChargeType String PrePaid

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

  • PrePaid:預付費,訂用帳戶。選擇該類計費方式時,您必須確認自己的帳號支援信用支付,否則將返回InvalidPayMethod的錯誤提示。
  • PostPaid:隨用隨付。
InstanceName String JoshuaHost

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

InstanceType String ecs.g5.large

執行個體的資源規格。更多詳情,請參見執行個體規格類型系列,也可以調用DescribeInstanceTypes介面獲得最新的規格表。

InternetChargeType String PayByTraffic

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

  • PayByTraffic:按使用流量計費
InternetMaxBandwidthIn Integer 200

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

InternetMaxBandwidthOut Integer 5

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

IoOptimized String optimized

是否為I/O最佳化執行個體。取值範圍:

  • none:非I/O最佳化
  • optimized:I/O最佳化
KeyPairName String Instancetest

金鑰組名稱。

  • Windows執行個體,忽略該參數。即使填寫了該參數,仍舊只執行Password的內容。
  • Linux執行個體的密碼登入方式會被初始化成禁止。
NetworkInterface.N.Description String FinanceDept

彈性網卡描述資訊。長度為2~256個英文或中文字元,不能以http://和https://開頭。

说明 彈性網卡相關請求參數NetworkInterface.N的N取值不能大於1。
NetworkInterface.N.NetworkInterfaceName String FinanceJoshua

彈性網卡名稱。

说明 彈性網卡相關請求參數NetworkInterface.N的N取值不能大於1。
NetworkInterface.N.PrimaryIpAddress String 192.168.2.XXX

彈性網卡的主私人IP地址。

说明 彈性網卡相關請求參數NetworkInterface.N的N取值不能大於1。
NetworkInterface.N.SecurityGroupId String sg-bp15ed6xe1yxeycg7***

彈性網卡所屬安全性群組的ID。彈性網卡的安全性群組和執行個體的安全性群組必須在同一個VPC下。

说明 彈性網卡相關請求參數NetworkInterface.N的N取值不能大於1。
NetworkInterface.N.VSwitchId String vsw-bp1s5fnvk4gn2tws03***

彈性網卡所屬的虛擬交換器ID。執行個體與彈性網卡必須在同一VPC的同一可用性區域中,可以分屬於不同交換器。

说明 彈性網卡相關請求參數NetworkInterface.N的N取值不能大於1。
NetworkType String vpc

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

  • classic
  • vpc
Period Integer 1

購買資源的時間長度,單位為:月。當參數InstanceChargeType取值為 PrePaid時才生效且為必選值。一旦指定了DedicatedHostId,則取值範圍不能超過Dedicated Host的訂閱時間長度。取值範圍:

  • PeriodUnit=Week時,Period取值:{“1”, “2”, “3”, “4”}
  • PeriodUnit=Month時,Period取值:{ “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “12”, “24”, “36”,”48”,”60”}
RamRoleName String FinanceDept

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

ResourceGroupId String rg-resourcegroupid1

執行個體、Block Storage和彈性網卡所在的企業資源組ID。

SecurityEnhancementStrategy String Deactive

是否為作業系統開啟安全強化。取值範圍:

  • Active:啟用安全強化,只對公用鏡像生效。
  • Deactive:不啟用安全強化,對所有鏡像類型生效。
SecurityGroupId String sg-bp15ed6xe1yxeycg7***

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

SpotDuration Integer 1

執行個體保護周期。

说明 該參數即將被棄用,為提高相容性,請盡量使用其他參數。
SpotPriceLimit Float 0.97

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

SpotStrategy String NoSpot

按量執行個體的搶佔策略。當參數InstanceChargeType取值為PostPaid時生效。取值範圍:

  • NoSpot:正常隨用隨付執行個體。
  • SpotWithPriceLimit:設定上限價格的搶佔式執行個體。
  • SpotAsPriceGo:系統自動出價,跟隨當前市場實際價格。
SystemDisk.Category String cloud_ssd

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

  • cloud:普通雲端硬碟
  • cloud_efficiency:高效雲端硬碟
  • cloud_ssd:SSD雲端硬碟
  • cloud_essd:ESSD雲端硬碟
SystemDisk.Description String FinanceDept

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

SystemDisk.DiskName String cloud_ssdSystem

系統硬碟名稱。長度為2~128個英文或中文字元。必須以大小字母或中文開頭,不能以http://和https://開頭。可以包含數字、半形冒號(:)、底線(_)或者連字號(-)。

SystemDisk.Size Integer 40

系統硬碟大小,單位為GiB。取值範圍:20~500

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

Tag.N.Key String FinanceDept

執行個體、Block Storage和主網卡的標籤鍵。N的取值範圍:1~5。一旦傳入該值,則不允許為空白字串。最多支援64個字元,不能以aliyun和acs:開頭,不能包含http://或者https://。

Tag.N.Value String FinanceDept.Joshua

執行個體、Block Storage和主網卡的標籤值。N的取值範圍:1~5。一旦傳入該值,可以為空白字串。最多支援128個字元,不能以aliyun和acs:開頭,不能包含http://或者https://。

TemplateResourceGroupId String rg-resourcegroupid2

啟動模板所在的企業資源組ID。

TemplateTag.N.Key String LTFinance

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

TemplateTag.N.Value String LTFinanceJoshua

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

UserData String ZWNobyBoZWxsbyBlY3Mh

執行個體自訂資料,需要以Base64方式編碼,未經處理資料最多為16 KB。

VSwitchId String vsw-bp1s5fnvk4gn2tws03***

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

VersionDescription String LTFinanceJoshua

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

VpcId String vpc-bp12433upq1y5sceni***

Virtual Private Cloud ID。

ZoneId String cn-hangzhou-g

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

返回資料

名稱 類型 樣本值 描述
LaunchTemplateId String lt-m5eiaupmvm2op9d*****

執行個體啟動模板 ID。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

請求ID。

樣本

請求樣本

https://ecs.aliyuncs.com/?Action=CreateLaunchTemplate
&LaunchTemplateName=JoshuaWinPrePaid
&RegionId=cn-hangzhou
&TemplateTag.1.Key=LTFinance
&TemplateTag.1.Value=LTFinanceJoshua
&VersionDescription=LTFinanceJoshua
&ImageId=win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd
&InstanceType=ecs.g5.large
&SecurityGroupId=sg-bp15ed6xe1yxeycg7***
&VpcId=vpc-bp12433upq1y5sceni07X
&VSwitchId=vsw-bp1s5fnvk4gn2tws03***
&InstanceName=JoshuaHost
&Description=FinaceDept
&InternetMaxBandwidthIn=200
&InternetMaxBandwidthOut=5
&HostName=JoshuaHost
&ZoneId=cn-hangzhou-g
&SystemDisk.Category=cloud_ssd
&SystemDisk.Size=40
&SystemDisk.DiskName=cloud_ssdSystem
&SystemDisk.Description=FinanceDept
&DataDisk.1.Size=2000
&DataDisk.1.SnapshotId=s-bp17441ohwka0yuhx***
&DataDisk.1.Category=cloud_ssd
&DataDisk.1.Encrypted=false
&DataDisk.1.DiskName=cloud_ssdData
&DataDisk.1.Description=FinanceDept
&DataDisk.1.DeleteWithInstance=true
&IoOptimized=optimized
&NetworkInterface.1.PrimaryIpAddress=192.168.2.XXX
&NetworkInterface.1.VSwitchId=vsw-bp1s5fnvk4gn2tws03***
&NetworkInterface.1.SecurityGroupId=sg-bp15ed6xe1yxeycg7***
&NetworkInterface.1.1etworkInterfaceName=FinnanceJoshua
&NetworkInterface.1.Description=FinnanceDept
&InstanceChargeType=PrePaid
&Period=1
&InternetChargeType=PayByTraffic
&NetworkType=vpc
&UserData=ZWNobyBoZWxsbyBlY3Mh
&KeyPairName=Instancetest
&RamRoleName=FinanceDept
&AutoReleaseTime=2018-01-01T12:05:00Z
&SpotStrategy=NoSpot
&SpotPriceLimit=0.97
&SecurityEnhancementStrategy=Deactive
&Tag.1.Key=FinanceDept
&Tag.1.Value=FinanceDept.Joshua
&<公用請求參數>

正常返回樣本

XML 格式

<CreateLaunchTemplateResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FExxxxx</RequestId>
      <LaunchTemplateId>lt-m5eiaupmvm2op9d*****</LaunchTemplateId>
</CreateLaunchTemplateResponse>

JSON 格式

{
	"LaunchTemplateId":"lt-m5eiaupmvm2op9d*****",
	"RequestId":"04F0F334-1335-436C-A1D7-6C044FExxxxx"
}

錯誤碼

HttpCode 錯誤碼 錯誤資訊 描述
400 InvalidRegion.NotExist %s 指定的Region不存在。
403 LaunchTemplateLimitExceed %s 啟動模板數量達到上限。
403 LaunchTemplateName.Duplicated %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. 指定的模板版本描述格式無效。
403 InnerServiceFailed %s 內部服務調用失敗。
400 InvalidUserData.SizeExceeded %s UserData大小超出限制。
400 InvalidUserData.Base64FormatInvalid %s 指定的模板版本描述格式無效。

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