ECS インスタンス起動テンプレートのバージョン情報 (インスタンス起動テンプレートの総数、テンプレート名、テンプレートのバージョン番号など) を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:DescribeLaunchTemplateVersions |
list |
LaunchTemplate。
LaunchTemplate。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
起動テンプレートのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストを照会できます。 |
cn-hangzhou |
| LaunchTemplateVersion |
array |
任意 |
1 つ以上の起動テンプレートのバージョン番号。 |
1 |
|
integer |
任意 |
1 つ以上の起動テンプレートのバージョン番号。 |
1 |
|
| LaunchTemplateId |
string |
任意 |
起動テンプレートの ID。 テンプレートを特定するには、LaunchTemplateId または LaunchTemplateName を指定する必要があります。 |
lt-bp168lnahrdwl39p**** |
| LaunchTemplateName |
string |
任意 |
起動テンプレート名。 テンプレートを特定するには、LaunchTemplateId または LaunchTemplateName を指定する必要があります。 |
testLaunchTemplateName |
| MinVersion |
integer |
任意 |
クエリ結果をフィルターするために使用される最小バージョン番号。MaxVersion と共に使用して、最小バージョン番号と最大バージョン番号の有効値内のバージョン情報を照会します。 |
1 |
| MaxVersion |
integer |
任意 |
クエリ結果をフィルターするために使用される最大バージョン番号。MinVersion と共に使用して、最小バージョン番号と最大バージョン番号の有効値内のバージョン情報を照会します。 |
10 |
| DefaultVersion |
boolean |
任意 |
デフォルトバージョンを照会するかどうかを指定します。 |
true |
| DetailFlag |
boolean |
任意 |
テンプレートの詳細な構成情報を照会するかどうかを指定します。有効な値:
|
true |
| PageNumber |
integer |
任意 |
起動テンプレートリストのページ番号。 最小値: 1。 デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリにおける 1 ページあたりのエントリ数。ページングクエリの 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 |
テンプレートが変更された時間。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。 |
2022-01-17T08:40:00Z |
| LaunchTemplateId |
string |
テンプレートの ID。 |
lt-bp67acfmxazb4p**** |
| CreateTime |
string |
テンプレートが作成された時間。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。 |
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) のパフォーマンスレベル (PL) 設定。有効な値:
ESSD のパフォーマンスレベルの選択方法の詳細については、 ESSD をご参照ください。 |
PL0 |
| KeyPairName |
string |
キーペアの名前。 |
testKeyPairName |
| SecurityGroupId |
string |
インスタンスのセキュリティグループ ID。 説明
SecurityGroupId と SecurityGroupIds は同時に返されません。 |
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 |
インスタンスの時間単価の最大値。 |
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 |
自動リリース時間。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。 |
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 |
インスタンスが属する 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 (エンタープライズ SSD) のパフォーマンスレベル (PL) の設定。このパラメーターは、Category=cloud_essd の場合にのみ返されます。有効な値:
|
PL1 |
| Description |
string |
データディスクの説明。 |
testDiskDescription |
| SnapshotId |
string |
データディスクで使用されるスナップショットの ID。 |
s-bp67acfmxazb4p**** |
| Device |
string |
データディスクのマウントポイント。命名規則は、アタッチされているデータディスクの数によって異なります。
説明
このパラメーターは、フルイメージ (マシン全体イメージ) に対してのみ使用されます。このパラメーターをフルイメージ内のデータディスクのマウントポイントに設定し、対応する DataDisk.N.Size および DataDisk.N.Category パラメーターを変更することで、フルイメージ内のデータディスクのカテゴリとサイズを変更できます。 |
/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 × Capacity - Baseline performance}。 Baseline performance = min{1,800 + 50 × Capacity, 50,000} 説明
このパラメーターは、DiskCategory が cloud_auto に設定されている場合にのみサポートされます。詳細については、ESSD AutoPL ディスク および ESSD AutoPL ディスクのプロビジョニングされたパフォーマンスの変更 をご参照ください。 |
50000 |
| BurstingEnabled |
boolean |
バースト機能が有効かどうかを示します。有効な値:
|
true |
| AutoSnapshotPolicyId |
string |
自動スナップショットポリシーの ID。 |
sp-wz91dz3ghear2a5s**** |
| KMSKeyId |
string |
データディスクの Key Management Service (KMS) キー ID。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| NetworkInterfaces |
object |
||
| NetworkInterface |
array<object> |
セカンダリネットワークインターフェースのプロパティ設定のコレクション。 |
|
|
array<object> |
セカンダリネットワークインターフェースのプロパティ設定のコレクション。 |
||
| NetworkInterfaceName |
string |
セカンダリネットワークインターフェースの名前。 |
testNetworkInterfaceName |
| VSwitchId |
string |
ネットワークインターフェースが属する vSwitch の ID。 |
vsw-bp67acfmxazb4p**** |
| Description |
string |
セカンダリネットワークインターフェースの説明。 |
testNetworkInterfacesDescription |
| PrimaryIpAddress |
string |
セカンダリネットワークインターフェースのプライマリ非公開 IP アドレス。 |
203.0.*.* |
| SecurityGroupId |
string |
セカンダリネットワークインターフェースのセキュリティグループ ID。セキュリティグループは同じ VPC に属している必要があります。 説明
SecurityGroupId と SecurityGroupIds は同時に返されません。 |
sg-bp67acfmxazb4p**** |
| SecurityGroupIds |
object |
||
| SecurityGroupId |
array |
セカンダリネットワークインターフェースが属する 1 つ以上のセキュリティグループ。 説明
SecurityGroupId と SecurityGroupIds は同時に返されません。 |
|
|
string |
セカンダリネットワークインターフェースが属する 1 つ以上のセキュリティグループ。 説明
SecurityGroupId と SecurityGroupIds は同時に返されません。 |
["sg-bp15ed6xe1yxeycg7****"] |
|
| InstanceType |
string |
インスタンスタイプ |
ecs.s2.xlarge |
| NetworkInterfaceTrafficMode |
string |
プライマリ ENI の通信モード。有効な値:
|
標準 |
| DeleteOnRelease |
boolean |
インスタンスのリリース時に ENI を保持するかどうかを示します。有効な値:
|
true |
| Tags |
object |
||
| InstanceTag |
array<object> |
インスタンスのタグ |
|
|
object |
インスタンスのタグ |
||
| Key |
string |
インスタンスのタグキー。 |
TestKey |
| Value |
string |
インスタンスのタグ値。 |
TestValue |
| SecurityGroupIds |
object |
||
| SecurityGroupId |
array |
インスタンスが属するセキュリティグループの ID。 説明
SecurityGroupId と SecurityGroupIds が同時に返されることはありません。 |
|
|
string |
インスタンスが属するセキュリティグループの ID。 説明
SecurityGroupId と SecurityGroupIds が同時に返されることはありません。 |
["sg-bp15ed6xe1yxeycg7****"] |
|
| SystemDisk.ProvisionedIops |
integer |
ESSD AutoPL ディスクのプロビジョニングされた読み取り/書き込み IOPS。有効な値: 0 ~ min{50,000, 1,000 × Capacity - ベースラインパフォーマンス}。 ベースラインパフォーマンス = min{1,800 + 50 × Capacity, 50,000} 説明
このパラメーターは、DiskCategory が 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 |
バースト可能インスタンスのパフォーマンスモード。有効な値:
|
標準 |
| AutoRenew |
boolean |
自動更新が有効かどうかを示します。このパラメーターは、InstanceChargeType が PrePaid に設定されている場合にのみ適用されます。有効な値:
デフォルト値: 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 キー ID。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| ImageOptions |
object |
イメージ関連のプロパティ情報。 |
|
| LoginAsNonRoot |
boolean |
このイメージを使用するインスタンスが ecs-user ユーザーでのログインをサポートするかどうかを示します。 有効な値:
|
false |
| SecurityOptions |
object |
セキュリティオプション。 |
|
| TrustedSystemMode |
string |
vTPM モード。値を vTPM に設定します。 次のインスタンスファミリーが vTPM モードをサポートしています。
前述のインスタンスファミリーの ECS インスタンスを作成する場合は、このパラメーターを設定する必要があります。次の点に注意してください。
説明
インスタンスの作成時に信頼されたインスタンスとして指定した場合、システムディスクは vTPM をサポートするイメージでのみ置き換えることができます。 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",
"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": "標準",
"DeleteOnRelease": true
}
]
},
"Tags": {
"InstanceTag": [
{
"Key": "TestKey",
"Value": "TestValue"
}
]
},
"SecurityGroupIds": {
"SecurityGroupId": [
"[\"sg-bp15ed6xe1yxeycg7****\"]"
]
},
"SystemDisk.ProvisionedIops": 50000,
"SystemDisk.BurstingEnabled": true,
"SystemDisk.Encrypted": "false",
"DeletionProtection": false,
"CreditSpecification": "標準",
"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. | 指定された起動テンプレートが見つかりませんでした。パラメーターが正しいことを確認してください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。