ECS インスタンスの起動テンプレートバージョンに関する情報（起動テンプレートの総数、テンプレート名、テンプレートバージョン番号など）を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:DescribeLaunchTemplateVersions |
list |
LaunchTemplate
LaunchTemplate
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
起動テンプレートのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。 |
cn-hangzhou |
| LaunchTemplateVersion |
array |
任意 |
1 つ以上の起動テンプレートバージョン番号。 |
1 |
|
integer |
任意 |
1 つ以上の起動テンプレートバージョン番号。 |
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 |
任意 |
ページングクエリにおける 1 ページあたりのエントリ数。このパラメーターをページングに使用します。 デフォルト値: 10。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
バージョン情報のコレクション。 |
||
| PageSize |
integer |
ページングクエリにおける 1 ページあたりのエントリ数。このパラメーターをページングに使用します。 |
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 |
起動テンプレートを作成した Alibaba Cloud アカウントの ID。 |
123456789**** |
| VersionDescription |
string |
起動テンプレートのバージョンの説明。 |
testVersionDescription |
| LaunchTemplateData |
object |
起動テンプレートの構成。 |
|
| DeploymentSetId |
string |
デプロイメントセットの ID。 |
ds-bp1brhwhoqinyjd6**** |
| VpcId |
string |
VPC の ID。 |
v-bp67acfmxazb4p**** |
| SystemDisk.PerformanceLevel |
string |
システムディスクとして使用する ESSD (エンタープライズ SSD) のパフォーマンスレベル。デフォルト値：PL0。有効値：
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 |
スポットインスタンスの保護期間。単位：時間。有効値：
Alibaba Cloud は、インスタンスがリリースされる 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 |
スポットインスタンスの 1 時間あたりの最高価格。 |
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 |
インスタンスの Resource Access Management (RAM) ロールの名前。 |
testRamRoleName |
| VSwitchId |
string |
インスタンスを接続する vSwitch の 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 |
データディスクのマウントポイント。マウントポイントはデータディスクの数に基づいて名前が付けられます：
説明
このパラメーターは、完全なイメージを使用してインスタンスを作成するシナリオに適用できます。完全なイメージとは、オペレーティングシステム、アプリケーションソフトウェア、ビジネスデータを含むイメージです。これらのシナリオでは、パラメーターを完全なイメージに含まれるデータディスク N のマウントポイントに設定し、 |
/dev/xvdb |
| Size |
integer |
データディスクのサイズ。 |
2000 |
| DiskName |
string |
データディスクの名前。 |
testDiskName |
| Category |
string |
データディスクのカテゴリ。 |
cloud_ssd |
| DeleteWithInstance |
boolean |
インスタンスがリリースされるときにデータディスクをリリースするかどうかを示します。 |
true |
| Encrypted |
string |
データディスクが暗号化されているかどうかを示します。 |
false |
| ProvisionedIops |
integer |
ESSD AutoPL のプロビジョニングされた読み取り/書き込み IOPS。有効値：0 から min{50,000, 1,000 × 容量 - ベースライン IOPS}。 ベースライン IOPS = min{1,800 + 50 × 容量, 50,000}。 説明
このパラメーターは、DataDisk.N.Category を cloud_auto に設定した場合にのみ使用できます。詳細については、「ESSD AutoPL」および「ESSD AutoPL のパフォーマンス構成の変更」をご参照ください。 |
50000 |
| BurstingEnabled |
boolean |
バースト機能が有効になっているかどうかを示します。有効値：
|
true |
| AutoSnapshotPolicyId |
string |
自動スナップショットポリシーの ID。 |
sp-wz91dz3ghear2a5s**** |
| KMSKeyId |
string |
データディスクに使用される KMS キーの ID。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| NetworkInterfaces |
object |
||
| NetworkInterface |
array<object> |
セカンダリ Elastic Network Interface (ENI) の詳細。 |
|
|
array<object> |
セカンダリ ENI の詳細。 |
||
| NetworkInterfaceName |
string |
セカンダリ ENI の名前。 |
testNetworkInterfaceName |
| VSwitchId |
string |
ENI を接続する vSwitch の ID。 |
vsw-bp67acfmxazb4p**** |
| Description |
string |
セカンダリ ENI の説明。 |
testNetworkInterfacesDescription |
| PrimaryIpAddress |
string |
セカンダリ ENI のプライマリプライベート IP。 |
203.0.*.* |
| SecurityGroupId |
string |
セカンダリ ENI を割り当てるセキュリティグループの ID。セキュリティグループと ENI は同じ VPC に属している必要があります。 説明
SecurityGroupId と SecurityGroupIds は応答内で相互排他的です。 |
sg-bp67acfmxazb4p**** |
| SecurityGroupIds |
object |
||
| SecurityGroupId |
array |
セカンダリ ENI を割り当てるセキュリティグループの ID。 説明
SecurityGroupId と SecurityGroupIds は応答内で相互排他的です。 |
|
|
string |
セカンダリ ENI を割り当てるセキュリティグループの ID。 説明
SecurityGroupId と SecurityGroupIds は応答内で相互排他的です。 |
["sg-bp15ed6xe1yxeycg7****"] |
|
| InstanceType |
string |
インスタンスのインスタンスタイプ。 |
ecs.s2.xlarge |
| NetworkInterfaceTrafficMode |
string |
プライマリ ENI の通信モード。有効値：
|
Standard |
| DeleteOnRelease |
boolean |
関連付けられたインスタンスがリリースされるときに ENI を保持するかどうかを示します。有効値：
|
true |
| Tags |
object |
||
| InstanceTag |
array<object> |
インスタンスに追加するタグ。 |
|
|
object |
インスタンスに追加するタグ。 |
||
| Key |
string |
インスタンスに追加するタグのキー。 |
TestKey |
| Value |
string |
インスタンスに追加するタグの値。 |
TestValue |
| SecurityGroupIds |
object |
||
| SecurityGroupId |
array |
インスタンスを割り当てるセキュリティグループの ID。 説明
|
|
|
string |
インスタンスを割り当てるセキュリティグループの ID。 説明
|
["sg-bp15ed6xe1yxeycg7****"] |
|
| SystemDisk.ProvisionedIops |
integer |
ESSD AutoPL のプロビジョニングされた読み取り/書き込み IOPS。有効値：0 から min{50,000, 1,000 × 容量 - ベースライン IOPS}。 ベースライン IOPS = min{1,800 + 50 × 容量, 50,000}。 説明
このパラメーターは、DataDisk.N.Category を cloud_auto に設定した場合にのみ使用できます。詳細については、「ESSD AutoPL」および「ESSD AutoPL のパフォーマンス構成の変更」をご参照ください。 |
50000 |
| SystemDisk.BurstingEnabled |
boolean |
バースト機能が有効になっているかどうかを示します。有効値：
|
true |
| SystemDisk.Encrypted |
string |
システムディスクが暗号化されているかどうかを示します。有効値：
デフォルト値：false。 説明
香港ゾーン D またはシンガポールゾーン A でインスタンスを作成する場合、システムディスクを暗号化することはできません。 |
false |
| DeletionProtection |
boolean |
インスタンスのリリース保護が有効になっているかどうかを示します。このパラメーターは、ECS コンソールを使用するか、 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。 説明
インスタンスメタデータの詳細については、「インスタンスメタデータを使用して ECS インスタンスの属性などの情報を取得する」をご参照ください。 |
enabled |
| HttpTokens |
string |
セキュリティ強化モード (IMDSv2) を強制的に使用してインスタンスメタデータにアクセスするかどうかを示します。有効値：
デフォルト値：optional。 説明
インスタンスメタデータへのアクセスモードの詳細については、「インスタンスメタデータを使用して ECS インスタンスの属性などの情報を取得する」をご参照ください。 |
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。有効値：vTPM。 現在、次のインスタンスファミリーが vTPM をサポートしています：
上記のインスタンスファミリーのいずれかの ECS インスタンスを作成する場合、このパラメーターを設定する必要があります。詳細は次のとおりです：
説明
作成時にインスタンスを信頼されたインスタンスとして指定した場合、そのシステムディスクを交換する際には、vTPM をサポートするイメージのみを使用できます。 vTPM の詳細については、「強化インスタンスの信頼された機能の概要」をご参照ください。 |
vTPM |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。