DescribeLaunchTemplateVersions
查詢 ECS 執行個體啟動範本版本的資訊,例如執行個體啟動範本總數、範本名稱、範本版本號等。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:DescribeLaunchTemplateVersions |
list |
LaunchTemplate
LaunchTemplate
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
執行個體啟動範本所屬的地域 ID。 您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。 |
cn-hangzhou |
| LaunchTemplateVersion |
array |
否 |
一個或多個執行個體啟動範本版本號。 |
1 |
|
integer |
否 |
一個或多個執行個體啟動範本版本號。 |
1 |
|
| LaunchTemplateId |
string |
否 |
執行個體啟動範本 ID。 您必須指定 |
lt-bp168lnahrdwl39p**** |
| LaunchTemplateName |
string |
否 |
執行個體啟動範本名稱。 您必須指定 |
testLaunchTemplateName |
| MinVersion |
integer |
否 |
限定查詢的最小版本號。與 |
1 |
| MaxVersion |
integer |
否 |
限定查詢的最大版本號。與 |
10 |
| DefaultVersion |
boolean |
否 |
是否查詢預設版本。 |
true |
| DetailFlag |
boolean |
否 |
是否查詢範本配置詳細資訊。取值範圍:
預設值:true。 |
true |
| PageNumber |
integer |
否 |
執行個體啟動範本列表的頁碼。 起始值:1。 預設值:1。 |
1 |
| PageSize |
integer |
否 |
分頁查詢時設置的每頁行數。 預設值:10。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
版本資訊集合。 |
||
| PageSize |
integer |
分頁查詢時設置的每頁行數。 |
10 |
| RequestId |
string |
請求 ID。 |
3989ED0C-20A1-4351-A127-2067FF8390AX |
| PageNumber |
integer |
當前頁碼。 |
1 |
| TotalCount |
integer |
執行個體啟動範本總數。 |
1 |
| LaunchTemplateVersionSets |
object |
||
| LaunchTemplateVersionSet |
array<object> |
範本版本的資訊。 |
|
|
array<object> |
範本版本的資訊。 |
||
| LaunchTemplateName |
string |
模板名稱。 |
testLaunchTemplateName |
| DefaultVersion |
boolean |
模板是否為預設版本。 |
true |
| VersionNumber |
integer |
模板版本號碼。 |
1 |
| ModifiedTime |
string |
模板修改時間。 |
2022-01-17T08:40:00Z |
| LaunchTemplateId |
string |
模板 ID。 |
lt-bp67acfmxazb4p**** |
| CreateTime |
string |
模板建立時間。 |
2022-01-17T08:22:43Z |
| CreatedBy |
string |
模板的建立者,即阿里雲帳號 ID。 |
123456789**** |
| VersionDescription |
string |
模板版本描述。 |
testVersionDescription |
| LaunchTemplateData |
object |
模板具體配置。 |
|
| DeploymentSetId |
string |
部署集 ID。 |
ds-bp1brhwhoqinyjd6**** |
| VpcId |
string |
Virtual Private Cloud ID。 |
v-bp67acfmxazb4p**** |
| SystemDisk.PerformanceLevel |
string |
建立 ESSD 雲端硬碟作為系統硬碟使用時,設定雲端硬碟的效能等級。可能值:
有關如何選擇 ESSD 效能等級,請參見 ESSD 雲端硬碟。 |
PL0 |
| KeyPairName |
string |
金鑰組名稱。 |
testKeyPairName |
| SecurityGroupId |
string |
執行個體的安全性群組 ID。 說明
|
sg-bp67acfmxazb4p**** |
| NetworkType |
string |
網路類型。可能值:
|
vpc |
| SpotStrategy |
string |
隨用隨付執行個體的競價策略。可能值:
|
NoSpot |
| EnableVmOsConfig |
boolean |
是否啟用執行個體作業系統配置。 |
false |
| Description |
string |
執行個體描述。 |
testInstanceDescription |
| SpotDuration |
integer |
搶佔式執行個體的保留時間長度,單位為小時。 可能值:
執行個體回收前 5 分鐘阿里雲會通過 ECS 系統事件向您發送通知。搶佔式執行個體按秒計費,建議您結合具體任務執行耗時來選擇合適的保留時間長度。 說明
當 SpotStrategy 值為 SpotWithPriceLimit 或 SpotAsPriceGo 時返回該參數。 |
1 |
| InstanceName |
string |
執行個體名稱。 |
testInstanceName |
| SecurityEnhancementStrategy |
string |
是否開啟安全強化。 |
active |
| UserData |
string |
執行個體自訂資料,以 Base64 方式編碼。 |
SGVsbG9FQ1M= |
| SystemDisk.DiskName |
string |
系統硬碟名稱。 |
testSystemDiskName |
| SystemDisk.Size |
integer |
系統硬碟大小,單位:GiB。 |
40 |
| SpotPriceLimit |
number |
設定執行個體的每小時最高價格。 |
0.98 |
| PasswordInherit |
boolean |
是否繼承原鏡像裡設定的使用者名稱密碼。 |
true |
| PrivateIpAddress |
string |
執行個體私網 IP 位址。 |
10.1.**.** |
| ImageId |
string |
執行個體使用的鏡像 ID。 |
m-bp67acfmxazb4p**** |
| SystemDisk.DeleteWithInstance |
boolean |
系統硬碟是否隨執行個體釋放。可能值:
|
true |
| SystemDisk.Category |
string |
系統硬碟的雲端硬碟種類。可能值:
已停售的執行個體規格且非 I/O 最佳化執行個體預設值為 cloud,否則預設值為 cloud_efficiency。 |
cloud_ssd |
| AutoReleaseTime |
string |
自動釋放時間。 |
2018-05-14T14:18:00Z |
| SystemDisk.Description |
string |
系統硬碟描述。 |
testSystemDiskDescription |
| ImageOwnerAlias |
string |
鏡像來源。可能值:
|
system |
| HostName |
string |
執行個體主機名稱。 |
testHostName |
| SystemDisk.Iops |
integer |
系統硬碟總 IOPS。 |
101800 |
| SystemDisk.AutoSnapshotPolicyId |
string |
自動快照策略 ID。 |
sp-bp1j0alc2z1fhvie**** |
| InternetMaxBandwidthOut |
integer |
公網出頻寬最大值。 |
100 |
| InternetMaxBandwidthIn |
integer |
公網入頻寬最大值。 |
5 |
| InstanceType |
string |
執行個體規格。 |
ecs.g5.large |
| Period |
integer |
購買資源的時間長度。 |
1 |
| InstanceChargeType |
string |
執行個體計費類型。可能值:
|
Postpaid |
| IoOptimized |
string |
是否為 I/O 最佳化執行個體。 |
none |
| RamRoleName |
string |
執行個體 RAM 角色名稱。 |
testRamRoleName |
| VSwitchId |
string |
執行個體所屬的虛擬交換器 ID。 |
vsw-bp67acfmxazb4p**** |
| ResourceGroupId |
string |
啟動模板所在的企業資源組 ID。 |
rg-bp67acfmxazb4p**** |
| InternetChargeType |
string |
公網頻寬計費方式。 |
PayByTraffic |
| ZoneId |
string |
可用性區域 ID。 |
cn-hangzhou-g |
| Ipv6AddressCount |
integer |
執行個體的 IPv6 地址數量。 |
1 |
| DataDisks |
object |
||
| DataDisk |
array<object> |
資料盤集合。 |
|
|
object |
資料盤集合。 |
||
| PerformanceLevel |
string |
建立 ESSD 雲端硬碟作為資料盤使用時,設定雲端硬碟的效能等級。當
|
PL1 |
| Description |
string |
資料盤描述。 |
testDiskDescription |
| SnapshotId |
string |
資料盤使用的快照 ID。 |
s-bp67acfmxazb4p**** |
| Device |
string |
資料盤的掛載點。掛載的資料盤數量不同,掛載點的命名不同:
說明
該參數僅用於全鏡像(整機鏡像)情境。您可以通過將此參數設定為全鏡像中資料盤對應的掛載點,並修改對應的 |
/dev/xvdb |
| Size |
integer |
資料盤大小。 |
2000 |
| DiskName |
string |
資料盤名稱。 |
testDiskName |
| Category |
string |
資料盤 N 的雲端硬碟種類。取值範圍:
對於 I/O 最佳化執行個體,預設值為 cloud_efficiency。對於非 I/O 最佳化執行個體,預設值為 cloud。 參數預設值說明:
|
cloud_ssd |
| DeleteWithInstance |
boolean |
資料盤是否隨執行個體釋放而釋放。 |
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-wz91dz3ghear2a5s**** |
| KMSKeyId |
string |
資料盤對應的 KMS 金鑰識別碼。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| NetworkInterfaces |
object |
||
| NetworkInterface |
array<object> |
輔助彈性網卡的屬性集合。 |
|
|
array<object> |
輔助彈性網卡的屬性集合。 |
||
| NetworkInterfaceName |
string |
輔助彈性網卡名稱。 |
testNetworkInterfaceName |
| VSwitchId |
string |
彈性網卡所屬的虛擬交換器 ID。 |
vsw-bp67acfmxazb4p**** |
| Description |
string |
輔助彈性網卡描述資訊。 |
testNetworkInterfacesDescription |
| PrimaryIpAddress |
string |
輔助彈性網卡的主私人 IP 位址。 |
203.0.*.* |
| SecurityGroupId |
string |
輔助彈性網卡所屬的安全性群組 ID。必須是同一個 VPC 下的安全性群組。 說明
SecurityGroupId 和 SecurityGroupIds 不會同時傳回值。 |
sg-bp67acfmxazb4p**** |
| SecurityGroupIds |
object |
||
| SecurityGroupId |
array |
輔助彈性網卡加入的一個或多個安全性群組。 說明
SecurityGroupId 和 SecurityGroupIds 不會同時傳回值。 |
|
|
string |
輔助彈性網卡加入的一個或多個安全性群組。 說明
SecurityGroupId 和 SecurityGroupIds 不會同時傳回值。 |
["sg-bp15ed6xe1yxeycg7****"] |
|
| InstanceType |
string |
執行個體的規格。 |
ecs.s2.xlarge |
| NetworkInterfaceTrafficMode |
string |
主網卡的通訊模式。參數取值範圍:
|
Standard |
| DeleteOnRelease |
boolean |
釋放執行個體時是否保留網卡。可能值:
|
true |
| Tags |
object |
||
| InstanceTag |
array<object> |
執行個體的標籤列表。 |
|
|
object |
執行個體的標籤列表。 |
||
| Key |
string |
執行個體的標籤鍵。 |
TestKey |
| Value |
string |
執行個體的標籤值。 |
TestValue |
| SecurityGroupIds |
object |
||
| SecurityGroupId |
array |
執行個體加入的一個或多個安全性群組。 說明
|
|
|
string |
執行個體加入的一個或多個安全性群組。 說明
|
["sg-bp15ed6xe1yxeycg7****"] |
|
| 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 |
| 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。 說明
有關執行個體中繼資料的資訊,請參見執行個體中繼資料概述。 |
enabled |
| HttpTokens |
string |
訪問執行個體中繼資料時是否強制使用加固模式(IMDSv2)。可能值:
預設值:optional。 說明
有關訪問執行個體中繼資料的模式,請參見執行個體中繼資料概述。 |
optional |
| HttpPutResponseHopLimit |
integer |
說明
該參數暫未開放使用。 |
3 |
| SystemDisk.KMSKeyId |
string |
系統硬碟對應的 KMS 金鑰識別碼。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| ImageOptions |
object |
鏡像相關屬性資訊。 |
|
| LoginAsNonRoot |
boolean |
使用該鏡像的執行個體是否支援使用 ecs-user 使用者登入。 可能值:
|
false |
| SecurityOptions |
object |
安全選項。 |
|
| TrustedSystemMode |
string |
可信系統模式。取值:vTPM。 目前,可信系統模式支援的執行個體規格類型系列:
當您建立以上執行個體規格類型系列的 ECS 執行個體時,需要設定該參數。具體說明如下:
說明
如果您在建立執行個體的時候指定其為可信執行個體,那麼當您更換系統硬碟時只能使用支援可信系統的鏡像。 關於可信系統的更多資訊,請參見安全增強型執行個體可信功能概述。 |
vTPM |
樣本
正常返回樣本
JSON格式
{
"PageSize": 10,
"RequestId": "3989ED0C-20A1-4351-A127-2067FF8390AX",
"PageNumber": 1,
"TotalCount": 1,
"LaunchTemplateVersionSets": {
"LaunchTemplateVersionSet": [
{
"LaunchTemplateName": "testLaunchTemplateName",
"DefaultVersion": true,
"VersionNumber": 1,
"ModifiedTime": "2022-01-17T08:40:00Z",
"LaunchTemplateId": "lt-bp67acfmxazb4p****",
"CreateTime": "2022-01-17T08:22:43Z",
"CreatedBy": "123456789****",
"VersionDescription": "testVersionDescription",
"LaunchTemplateData": {
"DeploymentSetId": "ds-bp1brhwhoqinyjd6****",
"VpcId": "v-bp67acfmxazb4p****",
"SystemDisk.PerformanceLevel": "PL0",
"KeyPairName": "testKeyPairName",
"SecurityGroupId": "sg-bp67acfmxazb4p****",
"NetworkType": "vpc",
"SpotStrategy": "NoSpot",
"EnableVmOsConfig": false,
"Description": "testInstanceDescription",
"SpotDuration": 1,
"InstanceName": "testInstanceName",
"SecurityEnhancementStrategy": "active",
"UserData": "SGVsbG9FQ1M=",
"SystemDisk.DiskName": "testSystemDiskName",
"SystemDisk.Size": 40,
"SpotPriceLimit": 0.98,
"PasswordInherit": true,
"PrivateIpAddress": "10.1.**.**",
"ImageId": "m-bp67acfmxazb4p****",
"SystemDisk.DeleteWithInstance": true,
"SystemDisk.Category": "cloud_ssd",
"AutoReleaseTime": "2018-05-14T14:18:00Z",
"SystemDisk.Description": "testSystemDiskDescription",
"ImageOwnerAlias": "system",
"HostName": "testHostName",
"SystemDisk.Iops": 101800,
"SystemDisk.AutoSnapshotPolicyId": "sp-bp1j0alc2z1fhvie****",
"InternetMaxBandwidthOut": 100,
"InternetMaxBandwidthIn": 5,
"InstanceType": "ecs.g5.large",
"Period": 1,
"InstanceChargeType": "Postpaid",
"IoOptimized": "none",
"RamRoleName": "testRamRoleName",
"VSwitchId": "vsw-bp67acfmxazb4p****",
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"InternetChargeType": "PayByTraffic",
"ZoneId": "cn-hangzhou-g",
"Ipv6AddressCount": 1,
"DataDisks": {
"DataDisk": [
{
"PerformanceLevel": "PL1",
"Description": "testDiskDescription",
"SnapshotId": "s-bp67acfmxazb4p****",
"Device": "/dev/xvdb\n",
"Size": 2000,
"DiskName": "testDiskName",
"Category": "cloud_ssd",
"DeleteWithInstance": true,
"Encrypted": "false",
"ProvisionedIops": 50000,
"BurstingEnabled": true,
"AutoSnapshotPolicyId": "sp-wz91dz3ghear2a5s****",
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****"
}
]
},
"NetworkInterfaces": {
"NetworkInterface": [
{
"NetworkInterfaceName": "testNetworkInterfaceName",
"VSwitchId": "vsw-bp67acfmxazb4p****",
"Description": "testNetworkInterfacesDescription",
"PrimaryIpAddress": "203.0.*.*",
"SecurityGroupId": "sg-bp67acfmxazb4p****",
"SecurityGroupIds": {
"SecurityGroupId": [
"[\"sg-bp15ed6xe1yxeycg7****\"]"
]
},
"InstanceType": "ecs.s2.xlarge",
"NetworkInterfaceTrafficMode": "Standard",
"DeleteOnRelease": true
}
]
},
"Tags": {
"InstanceTag": [
{
"Key": "TestKey",
"Value": "TestValue"
}
]
},
"SecurityGroupIds": {
"SecurityGroupId": [
"[\"sg-bp15ed6xe1yxeycg7****\"]"
]
},
"SystemDisk.ProvisionedIops": 50000,
"SystemDisk.BurstingEnabled": true,
"SystemDisk.Encrypted": "false",
"DeletionProtection": false,
"CreditSpecification": "Standard",
"AutoRenew": true,
"AutoRenewPeriod": 1,
"PeriodUnit": "Month",
"HttpEndpoint": "enabled",
"HttpTokens": "optional",
"HttpPutResponseHopLimit": 3,
"SystemDisk.KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****\n",
"ImageOptions": {
"LoginAsNonRoot": false
},
"SecurityOptions": {
"TrustedSystemMode": "vTPM"
}
}
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidRegion.NotExist | %s | |
| 400 | MissingParameter | %s | |
| 400 | InvalidParameter | %s | |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | |
| 403 | InnerServiceFailed | %s | |
| 404 | InvalidLaunchTemplate.NotFound | The specified LaunchTemplate is not found. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。