在指定的 ECS 執行個體啟動範本下建立一個新版本,用於後續建立 ECS 執行個體、彈性伸縮組或彈性供應組。
介面說明
介面說明
當您想修改某個版本的參數時,能透過新建範本版本的方式修改。每個執行個體啟動範本最多建立 30 個版本。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:CreateLaunchTemplateVersion |
create |
*LaunchTemplate
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。 |
cn-hangzhou |
| RegionId |
string |
是 |
地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。 |
cn-hangzhou |
| LaunchTemplateId |
string |
否 |
啟動範本 ID。更多資訊,請呼叫 DescribeLaunchTemplates 。您必須指定 |
lt-m5eiaupmvm2op9d**** |
| LaunchTemplateName |
string |
否 |
執行個體啟動範本名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以 |
testLaunchTemplateName |
| VersionDescription |
string |
否 |
執行個體啟動範本版本的描述。長度為 2~256 個英文或中文字元,不能以 |
testVersionDescription |
| ImageId |
string |
否 |
映像 ID,啟動執行個體時選擇的映像資源。您可以透過 DescribeImages 查詢您可以使用的映像資源。 |
win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd |
| ImageOwnerAlias |
string |
否 |
映像來源。 說明
該參數即將被棄用,為提高相容性,請盡量使用其他參數。 |
system |
| PasswordInherit |
boolean |
否 |
是否使用映像預設的密碼。取值範圍:
預設值:false。 說明
使用該參數時,Password 參數必須為空。同時您需要確保使用的映像已經設定了密碼。 |
false |
| InstanceType |
string |
否 |
執行個體的規格。更多資訊,請參見執行個體規格族,您也可以呼叫 DescribeInstanceTypes 介面取得最新的規格表。 |
ecs.g5.large |
| SecurityGroupId |
string |
否 |
指定使用該版本建立執行個體所屬於的安全性群組 ID。同一個安全性群組內的執行個體之間可以互相存取。 說明
不支援同時指定 |
sg-bp15ed6xe1yxeycg**** |
| VpcId |
string |
否 |
執行個體所屬專有網路 VPC ID。 |
vpc-bp12433upq1y5scen**** |
| VSwitchId |
string |
否 |
建立 VPC 類型執行個體時需要指定虛擬交換器 ID。 |
vsw-bp1s5fnvk4gn2tws0**** |
| InstanceName |
string |
否 |
執行個體名稱。長度為 2~128 個字元,支援 Unicode 中 letter 分類下的字元(其中包括英文、中文和數字等)。可以包含半形冒號(:)、底線(_)、半形句號(.)或者短劃線(-)。預設值為執行個體的 建立多台 ECS 執行個體時,您可以批次設定有序的執行個體名稱,並且可以包含方括號([])和逗號(,)。具體操作,請參見批次設定有序的執行個體名稱或主機名稱。 |
k8s-node-[1,4]-alibabacloud |
| Description |
string |
否 |
執行個體描述。長度為 2~256 個英文或中文字元,不能以 |
testDescription |
| InternetMaxBandwidthIn |
integer |
否 |
公網入頻寬最大值,單位為 Mbit/s。取值範圍:
|
50 |
| InternetMaxBandwidthOut |
integer |
否 |
公網出頻寬最大值,單位為 Mbit/s。取值範圍為 0~100。 |
5 |
| HostName |
string |
否 |
雲端伺服器的主機名稱。
|
testHostName |
| ZoneId |
string |
否 |
執行個體所屬的可用區 ID。 |
cn-hangzhou-g |
| SystemDisk.Category |
string |
否 |
系統磁碟的雲端硬碟種類。取值範圍:
已停售的執行個體規格且非 I/O 最佳化執行個體預設值為 cloud,否則預設值為 cloud_efficiency。 |
cloud_ssd |
| SystemDisk.Size |
integer |
否 |
系統磁碟大小,單位為 GiB。取值範圍:
該參數的取值必須大於或者等於 max{20, ImageSize}。 |
40 |
| SystemDisk.DiskName |
string |
否 |
系統磁碟名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭,不能以 |
cloud_ssdSystem |
| SystemDisk.Description |
string |
否 |
系統磁碟描述。長度為 2~256 個英文或中文字元,不能以 |
testSystemDiskDescription |
| SystemDisk.Iops |
integer |
否 |
說明
該參數暫未開放使用。 |
30000 |
| SystemDisk.PerformanceLevel |
string |
否 |
建立 ESSD 雲端硬碟作為系統磁碟使用時,設定雲端硬碟的效能等級。取值範圍:
有關如何選擇 ESSD 效能等級,請參見 ESSD 雲端硬碟。 |
PL0 |
| SystemDisk.DeleteWithInstance |
boolean |
否 |
系統磁碟是否隨執行個體釋放。取值範圍:
預設值:true。 |
true |
| SystemDisk.AutoSnapshotPolicyId |
string |
否 |
系統磁碟採用的自動快照策略 ID。 |
sp-bp1dgzpaxwc4load**** |
| 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 |
| IoOptimized |
string |
否 |
是否為 I/O 最佳化執行個體。取值範圍:
|
optimized |
| InstanceChargeType |
string |
否 |
執行個體的計費方式。取值範圍:
|
PrePaid |
| Period |
integer |
否 |
購買資源的時長,單位為:月。當參數 |
1 |
| InternetChargeType |
string |
否 |
公網出方向頻寬計費方式。取值範圍:
說明
按使用流量計費模式下的出入頻寬峰值都是頻寬上限,不作為業務承諾指標。當出現資源爭搶時,頻寬峰值可能會受到限制。如果您的業務需要有頻寬的保障,請使用按固定頻寬計費模式。 |
PayByTraffic |
| EnableVmOsConfig |
boolean |
否 |
是否啟用執行個體作業系統配置。 |
false |
| NetworkType |
string |
否 |
執行個體網路類型。取值範圍:
|
vpc |
| UserData |
string |
否 |
執行個體自訂資料,需要以 Base64 方式編碼,原始資料最多為 32 KB。 |
ZWNobyBoZWxsbyBl**** |
| KeyPairName |
string |
否 |
金鑰對名稱。
|
testKeyPairName |
| RamRoleName |
string |
否 |
執行個體 RAM 角色名稱。您可以使用 RAM API ListRoles 查詢您已建立的執行個體 RAM 角色。 |
testRamRoleName |
| AutoReleaseTime |
string |
否 |
自動釋放時間。按照 ISO 8601 標準表示,並需要使用 UTC 時間。格式為:yyyy-MM-ddTHH:mm:ssZ。
|
2018-01-01T12:05:00Z |
| SpotStrategy |
string |
否 |
隨用隨付執行個體的搶佔策略。當參數
|
NoSpot |
| SpotPriceLimit |
number |
否 |
設定執行個體的每小時最高價格。支援最大 3 位小數。 |
0.97 |
| SpotDuration |
integer |
否 |
搶佔式執行個體的保留時長,單位為小時。預設值:1。取值範圍:
執行個體回收前 5 分鐘阿里雲會透過 ECS 系統事件向您傳送通知。搶佔式執行個體按秒計費,建議您結合具體任務執行耗時來選擇合適的保留時長。 說明
當 SpotStrategy 值為 SpotWithPriceLimit 或 SpotAsPriceGo 時該參數生效。 |
1 |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-bp67acfmxazb4p**** |
| SecurityEnhancementStrategy |
string |
否 |
是否為作業系統開啟安全性加固。取值範圍:
|
Active |
| PrivateIpAddress |
string |
否 |
執行個體私網 IP 位址。 專有網路 VPC 類型 ECS 執行個體設定私網 IP 位址時,必須從虛擬交換器( |
10.1.**.** |
| Ipv6AddressCount |
integer |
否 |
為主網卡指定隨機產生的 IPv6 位址數量。取值範圍為 1~10。 |
1 |
| DeploymentSetId |
string |
否 |
部署集 ID。 |
ds-bp1brhwhoqinyjd6**** |
| DataDisk |
array<object> |
否 |
資料磁碟列表。 |
|
|
object |
否 |
資料磁碟列表。 |
||
| PerformanceLevel |
string |
否 |
建立 ESSD 雲端硬碟作為資料磁碟使用時,設定雲端硬碟的效能等級。N 的取值必須和
有關如何選擇 ESSD 效能等級,請參見 ESSD 雲端硬碟。 |
PL1 |
| Description |
string |
否 |
資料磁碟描述。長度為 2~256 個英文或中文字元,不能以 |
testDataDiskDescription |
| 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 |
| 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 |
| AutoSnapshotPolicyId |
string |
否 |
資料磁碟採用的自動快照策略 ID。 |
sp-bp67acfmxazb4p**** |
| KMSKeyId |
string |
否 |
資料磁碟對應的 KMS 密鑰 ID。 |
0e478b7a-4262-4802-b8cb-00d**** |
| NetworkInterface |
array<object> |
否 |
彈性網卡資訊。 |
|
|
object |
否 |
彈性網卡資訊。 |
||
| VSwitchId |
string |
否 |
輔助彈性網卡所屬的虛擬交換器 ID。執行個體與輔助彈性網卡必須在同一 VPC 的同一可用區中,可以分屬於不同交換器。 |
vsw-bp1s5fnvk4gn2tws0**** |
| NetworkInterfaceName |
string |
否 |
輔助彈性網卡名稱。 |
testNetworkInterfaceName |
| Description |
string |
否 |
輔助彈性網卡描述資訊。長度為 2~256 個英文或中文字元,不能以 |
testNetworkInterfaceDescription |
| SecurityGroupId |
string |
否 |
輔助彈性網卡所屬安全性群組的 ID。輔助彈性網卡的安全性群組和執行個體的安全性群組必須在同一個 VPC 下。 說明
不支援同時指定 |
sg-bp15ed6xe1yxeycg**** |
| PrimaryIpAddress |
string |
否 |
輔助彈性網卡的主私有 IP 位址。 |
192.168.**.** |
| SecurityGroupIds |
array |
否 |
輔助彈性網卡加入的一個或多個安全性群組。安全性群組和輔助彈性網卡必須在同一個專有網路 VPC 中。 說明
不支援同時指定 |
sg-bp67acfmxazb4p**** |
|
string |
否 |
輔助彈性網卡加入的一個或多個安全性群組。安全性群組和輔助彈性網卡必須在同一個專有網路 VPC 中。 說明
不支援同時指定 |
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> |
否 |
透過該版本建立的執行個體、雲端硬碟和主網卡的標籤資訊。 |
|
|
object |
否 |
透過該版本建立的執行個體、雲端硬碟和主網卡的標籤資訊。 |
||
| Key |
string |
否 |
透過該版本建立的執行個體、雲端硬碟和主網卡的標籤鍵。N 的取值範圍:1~20。一旦傳入該值,則不允許為空字串。最多支援 128 個字元,不能以 aliyun 和 acs: 開頭,不能包含 http:// 或 https://。 |
TestKey |
| Value |
string |
否 |
透過該版本建立的執行個體、雲端硬碟和主網卡的標籤值。N 的取值範圍:1~20。一旦傳入該值,可以為空字串。最多支援 128 個字元,不能包含 http:// 或者 https://。 |
TestValue |
| SecurityGroupIds |
array |
否 |
執行個體加入的一個或多個安全性群組。N 的取值範圍與執行個體能夠加入安全性群組配額有關。更多資訊,使用限制。 說明
不支援同時指定 |
sg-bp15ed6xe1yxeycg7**** |
|
string |
否 |
執行個體加入的一個或多個安全性群組。N 的取值範圍與執行個體能夠加入安全性群組配額有關。更多資訊,請參見使用限制。 說明
不支援同時指定 |
sg-bp15ed6xe1yxeycg7**** |
|
| SystemDisk.Encrypted |
string |
否 |
系統磁碟是否加密。取值範圍:
預設值:false。 說明
中國香港 D 可用區、新加坡 A 可用區暫不支援在建立執行個體時加密系統磁碟。 |
false |
| DeletionProtection |
boolean |
否 |
執行個體釋放保護屬性,指定是否支援透過主控台或 API( DeleteInstance )釋放執行個體。取值範圍:
預設值:false。 說明
該屬性僅適用於隨用隨付執行個體,且只能限制手動釋放操作,對系統釋放操作不生效。 |
false |
| CreditSpecification |
string |
否 |
設定突發效能執行個體的運行模式。取值範圍:
|
Standard |
| AutoRenew |
boolean |
否 |
是否要自動續費。當參數
預設值:false。 |
true |
| AutoRenewPeriod |
integer |
否 |
單次自動續費的續費時長。取值範圍: PeriodUnit=Month 時:1、2、3、6、12、24、36、48、60。 預設值:1。 |
1 |
| PeriodUnit |
string |
否 |
包年包月計費方式的時長單位。取值範圍: Month(預設)。 |
Month |
| HttpEndpoint |
string |
否 |
是否啟用執行個體中繼資料的存 实例元数据概述 |
enabled |
| HttpTokens |
string |
否 |
访问实例元数据时是否强制使用加固模式(IMDSv2)。取值范围:
默认值:optional。 說明
有关访问实例元数据的模式,请参见实例元数据概述。 |
optional |
| HttpPutResponseHopLimit |
integer |
否 |
說明
該參數暫未開放使用。 |
3 |
| SystemDisk.KMSKeyId |
string |
否 |
系統磁碟對應的 KMS 密鑰 ID。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| ImageOptions |
object |
否 |
镜像相关属性信息。 |
|
| LoginAsNonRoot |
boolean |
否 |
使用该镜像的实例是否支持使用 ecs-user 用户登录。 可能值:
|
false |
| SecurityOptions |
object |
否 |
安全选项。 |
|
| TrustedSystemMode |
string |
否 |
可信系统模式。取值:vTPM。 目前,可信系统模式支持的实例规格族:
当您创建以上实例规格族的 ECS 实例时,需要设置该参数。具体说明如下:
說明
如果您在创建实例的时候指定其为可信实例,那么当您更换系统盘时只能使用支持可信系统的镜像。 关于可信系统的更多信息,请参见安全增强型实例可信功能概述。 |
vTPM |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| LaunchTemplateVersionNumber |
integer |
创建成功的启动模板版本号。 |
2 |
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DEX**** |
| LaunchTemplateId |
string |
启动模板 ID。更多信息,请参见 DescribeLaunchTemplates 。 使用启动模板创建实例时,您必须指定 |
lt-bp1apo0bbbkuy0rj**** |
樣本
正常返回樣本
JSON格式
{
"LaunchTemplateVersionNumber": 2,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DEX****",
"LaunchTemplateId": "lt-bp1apo0bbbkuy0rj****"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidRegion.NotExist | %s | |
| 400 | MissingParameter | %s | |
| 400 | InvalidParameter | %s | |
| 400 | InvalidDescription.Malformed | The specified parameter "Description" is not valid. | |
| 400 | InvalidUserData.SizeExceeded | %s | |
| 400 | InvalidUserData.Base64FormatInvalid | %s | |
| 400 | InvalidHostName.Malformed | The specified parameter "HostName" is not valid. | |
| 400 | InvalidParams.CreateEniParams | %s | |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | LaunchTemplateVersionLimitExceed | %s | |
| 404 | InvalidLaunchTemplate.NotFound | %s | |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。