インスタンス起動テンプレート (略して起動テンプレート) を作成します。 インスタンス起動テンプレートを使用すると、インスタンス作成時に多数のパラメーターをその都度設定する必要がなくなります。
説明
インスタンス起動テンプレートには、インスタンスリージョン、イメージ ID、インスタンスタイプ、セキュリティグループ ID、パブリック帯域幅設定など、インスタンスの作成に使用されるプリセット構成が含まれています。
特定のパラメーターの構成がテンプレートに含まれていない場合、そのパラメーターはインスタンス作成中に手動で指定する必要があります。 テンプレート(CreateLaunchTemplate
)を作成すると、そのバージョン番号はデフォルトで 1 に設定されます。 このテンプレートに基づいて複数のバージョン(CreateLaunchTemplateVersion
)を作成できます。 バージョン番号は 1 から始まり、順番に増加します。 ECS インスタンスの作成 (RunInstances) 時にテンプレートのバージョン番号の指定がない場合、デフォルトのバージョンが使用されます。
本インターフェイスを呼び出す際は次の点に留意してください。
- 各リージョンで最大 30 のインスタンス起動テンプレートを作成できます。 各テンプレートは最大 30 のバージョンを持つことができます。
- ほとんどのインスタンス起動テンプレートパラメータは省略可能です。 テンプレートを作成する際、ECS はそのパラメーター値の存在または有効性を検証しません。 テンプレートを使用してインスタンスを作成するまで、指定したパラメーター値の有効性を検証できません。
- インスタンス起動テンプレートで特定のパラメーターを構成する場合、インスタンス(RunInstances)の作成時にこのパラメーターをフィルターで除外することはできません。 たとえば、テンプレートで
HostName=LocalHost
が構成されており、RunInstances
API でHostName
パラメーターの値が指定されていない場合、インスタンスのホスト名は引き続きLocalHost
となります。HostName=LocalHost
構成を上書きする場合、HostName=MyHost
API でRunInstances
及びその他のパラメーターを構成できます。
デバッグ
API Explorer でデバッグを実行できます。 API Explorer で各種操作を実行して API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK のサンプルコードの動的な生成ができます。
リクエストパラメーター
名前 | データ型 | 必須 | 例 | 説明 |
---|---|---|---|---|
LaunchTemplateName | String | 必須 | JoshuaWinPrePaid |
インスタンス起動テンプレートの名前。 名前の長さは 2 ~ 128 文字である必要があります。 名前は英字で始まる必要があります。注:http:// または https:// で始めることはできません。 英字、数字、コロン(:)、アンダースコア(_)、およびハイフン( - )を含めることができます。 |
RegionId | String | 必須 | cn-hangzhou |
リージョンの ID です。 DescribeRegions を呼び出すと、Alibaba Cloud の最新リージョンが表示されます。 |
Action | String | 省略可能 | CreateLaunchTemplate |
実行する操作。 値を CreateLaunchTemplate に設定します。 |
AutoReleaseTime | String | 省略可能 | 2018-01-01T12:05:00Z |
インスタンスが自動的に解放された時刻。 時間は、ISO 8601 標準、UTC 時間です。 形式: yyyy-MM-ddTHH:mm:ssZ。
|
DataDisk.n.Category | String | 省略可能 | cloud_ssd |
データディスク N のカテゴリ。有効値:
|
DataDisk.n.DeleteWithInstance | Boolean | 省略可能 | true |
データディスク N がインスタンスとともにリリースされるかどうかを示します。 |
DataDisk.n.Description | String | 省略可能 | FinanceDept |
データディスク N の説明。説明は、長さが 2 ~ 256 文字である必要があります。文頭に http:// または https:// を含めることはできません。 |
DataDisk.n.DiskName | String | 省略可能 | cloud_ssdData |
データディスクの名前。 名前の長さは 2 ~ 128 文字である必要があります。 名前は英字で始まる必要があります。注:http:// または https:// で始めることはできません。 英字、数字、コロン(:)、アンダースコア(_)、およびハイフン( - )を含めることができます。 |
DataDisk.n.Encrypted | String | 省略可能 | false |
データディスクが暗号化されているかを示します。 |
DataDisk.n.Size | Integer | 省略可能 | 2000 |
データディスク N のサイズ。N の有効値:1~16。 単位:GiB。 有効値:
このパラメーターの値は、 |
DataDisk.n.SnapshotId | String | 省略可能 | s-bp17441ohwka0yuhx3h0 |
データディスクの作成に使用されたスナップショットの ID。 N の有効値:1~16。 |
Description | String | 省略可能 | FinaceDept |
インスタンスの説明。 説明は、長さが 2 ~ 256 文字である必要があります。文頭に http:// または https:// を含めることはできません。 |
EnableVmOsConfig | Boolean | 省略可能 | false |
インスタンスのオペレーティングシステム構成を有効にするかどうかを示します。 注 このパラメーターは削除予定です。 互換性を確保するために他のパラメーターを使用することを推奨します。
|
HostName | String | 省略可能 | JoshuaHost |
作成された ECS インスタンスを含むホストの名前。
|
ImageId | String | 省略可能 | win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd |
インスタンスの作成に使用されるイメージファイルの ID。 DescribeImages を呼び出して、利用可能な画像をクエリできます。 |
ImageOwnerAlias | String | 省略可能 | system |
イメージのソース。 有効値:
デフォルト値:null。system、self、および others に一致する結果が返されることを示します。 |
InstanceChargeType | String | 省略可能 | PrePaid |
インスタンスの課金方法です。 有効値:
|
InstanceName | String | 省略可能 | JoshuaHost |
インスタンスの名前。 名前の長さは 2 ~ 128 文字である必要があります。 名前は英字で始まる必要があります。注:http:// または https:// で始めることはできません。 英字、数字、コロン(:)、アンダースコア(_)、およびハイフン( - )を含めることができます。 |
InstanceType | String | 省略可能 | ecs.g5.large |
インスタンスのタイプ。 詳細は、インスタンスタイプファミリーを参照するか、またはDescribeInstanceTypesを呼び出して最新のインスタンスタイプのリストを取得します。 |
InternetChargeType | String | 省略可能 | PayByTraffic |
ネットワーク帯域幅の課金方法。 有効値:
|
InternetMaxBandwidthIn | Integer | 省略可能 | 200 |
インターネットからのインバウンド帯域幅の最大値。 単位:Mbit/s。 有効値:1~200。 |
InternetMaxBandwidthOut | Integer | 省略可能 | 5 |
インターネットへのアウトバウンド帯域幅の最大値。 単位:Mbit/s。 有効値:0~100。 |
IoOptimized | String | 省略可能 | optimized |
インスタンスは I/O 最適化されているかを示します。 有効値:
|
KeyPairName | String | 省略可能 | インスタンステスト |
キーペアの名前。
|
NetworkInterface.n.Description | String | 省略可能 | FinnanceDept |
ENI の説明。 説明は、長さが 2 ~ 256 文字である必要があります。文頭に http:// または https:// を含めることはできません。 注
NetworkInterface.N パラメーターの N の値は 0 または 1 である必要があります。
|
NetworkInterface.n.NetworkInterfaceName | String | 省略可能 | FinnanceJoshua |
ENI の名前。 注
NetworkInterface.N パラメーターの N の値は 0 または 1 である必要があります。
|
NetworkInterface.n.PrimaryIpAddress | String | 省略可能 | 192.168.2.XXX |
ENI のプライマリプライベート IP アドレス。 注
NetworkInterface.N パラメーターの N の値は 0 または 1 である必要があります。
|
NetworkInterface.n.SecurityGroupId | String | 省略可能 | sg-bp15ed6xe1yxeycg7ov3 |
ENI が属するセキュリティグループの ID 。 ENI のセキュリティグループは、インスタンスと同じ VPC に属している必要があります。 注
NetworkInterface.N パラメーターの N の値は 0 または 1 である必要があります。
|
NetworkInterface.n.VSwitchId | String | 省略可能 | vsw-bp1s5fnvk4gn2tws03ziX |
ENI が属する VSwitch の ID。 インスタンスは、ENI と同じ VPC ネットワークの同じゾーンにある必要がありますが、異なる VSwitch に属することができます。 注
NetworkInterface.N パラメーターの N の値は 0 または 1 である必要があります。
|
NetworkType | String | 省略可能 | vpc |
インスタンスのネットワークタイプ。 有効値:
|
Period | Integer | 省略可能 | 1 |
サブスクリプションの期間。 単位:month 。 このパラメーターは、
|
RamRoleName | String | 省略可能 | FinanceDept |
インスタンスの RAM ロール名。 RAM API の ListRoles を呼び出して、お客様より作成された RAM ロールをクエリできます。 |
ResourceGroupId | String | 省略可能 | rg-resourcegroupid1 |
インスタンス、ディスク、ENI が属するリソースグループの ID 。 |
SecurityEnhancementStrategy | String | 省略可能 | Deactive |
オペレーティングシステムのセキュリティ強化を有効にするかどうかを示します。 有効値:
|
SecurityGroupId | String | 省略可能 | sg-bp15ed6xe1yxeycg7ov3 |
作成したインスタンスが属するセキュリティグループの ID。 同じセキュリティグループ内のインスタンスは相互にアクセスすることができます。 1 つのセキュリティグループには、最大 1,000 個のインスタンスを含めることができます。 |
SpotDuration | Integer | 省略可能 | 1 |
インスタンスの保護期間。 注 このパラメーターは削除予定です。 互換性を確保するために他のパラメーターを使用することを推奨します。
|
SpotPriceLimit | Float | 省略可能 | 0.97 |
インスタンスの最高価格/時。 このパラメーターは小数点以下 3 桁までサポートし、 |
SpotStrategy | String | 省略可能 | NoSpot |
従量課金インスタンスのプリエンプティブポリシー。 このパラメーターは、
|
SystemDisk.Category | String | 省略可能 | cloud_ssd |
システムディスクのカテゴリ。 有効値:
|
SystemDisk.Description | String | 省略可能 | FinanceDept |
システムディスクの説明。 説明は、長さが 2 ~ 256 文字である必要があります。文頭に http:// または https:// を含めることはできません。 |
SystemDisk.DiskName | String | 省略可能 | cloud_ssdSystem |
システムディスクの名前。 名前の長さは 2 ~ 128 文字である必要があります。 名前は英字で始まる必要があります。注:http:// または https:// で始めることはできません。 英字、数字、コロン(:)、アンダースコア(_)、およびハイフン( - )を含めることができます。 |
SystemDisk.Size | Integer | 省略可能 | 40 |
システムディスクのサイズ。 単位:GiB。 有効値:20~500 。 このパラメーターの値は、少なくとも 20 GiB、または ImageSize の値以上である必要があります。 |
Tag.N.Key | String | 省略可能 | FinanceDept |
インスタンス、ディスク、または NIC のタグキー。 N の有効値:1~5。 null 文字列にすることはできません。 長さは 64 文字以内である必要があります。 aliyun または acs: で始めることはできません。 http:// または https:// を含めることはできません。 |
Tag.N.Value | String | 省略可能 | FinanceDept.Joshua |
インスタンス、ディスク、または NIC のタグキー。 N の有効値:1~5。 null 文字列にできます。 長さは 128 文字以内である必要があります。 aliyun または acs: で始めることはできません。 http:// または https:// を含めることはできません。 |
TemplateResourceGroupId | String | 省略可能 | rg-resourcegroupid2 |
起動テンプレートが属するリソースグループの ID 。 |
TemplateTag.N.Key | String | 省略可能 | LTFinance |
起動テンプレートおタグキー。 N の有効値:1 ~ 20。 null 文字列にすることはできません。 長さは 64 文字以内である必要があります。 aliyun または acs: で始めることはできません。 http:// または https:// を含めることはできません。 |
TemplateTag.N.Value | String | 省略可能 | LTFinanceJoshua |
起動テンプレートのタグ値。 N の有効値:1 ~ 20。 null 文字列にできます。 長さは 128 文字以内である必要があります。 先頭文字列を ”aliyun”、”acs:”、”http://“ 、または “https://“ にすることはできません。 |
UserData | String | 省略可能 | ZWNobyBoZWxsbyBlY3Mh |
インスタンスのカスタムデータ。 Base64 でエンコードする必要があります。 生データの最大サイズは 16 KB です。 |
VSwitchId | String | 省略可能 | vsw-bp1s5fnvk4gn2tws03ziX |
VSwitch の ID。 VPC タイプのインスタンスを作成摺る場合、このパラメータを指定する必要があります。 |
VersionDescription | String | 省略可能 | LTFinanceJoshua |
インスタンス起動テンプレートバージョン 1 の説明。 説明は、長さが 2 ~ 256 文字である必要があります。文頭に http:// または https:// を含めることはできません。 |
VpcId | String | 省略可能 | vpc-bp12433upq1y5sceni07X |
VPC の ID。 |
ZoneId | String | 省略可能 | cn-hangzhou |
インスタンスが属するゾーン ID。 |
レスポンスパラメーター
名前 | データ型 | 例 | 説明 |
---|---|---|---|
LaunchTemplateId | String | lt-m5eiaupmvm2op9dxxxxx |
インスタンス起動テンプレートの 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-bp15ed6xe1yxeycg7ov3
&VpcId=vpc-bp12433upq1y5sceni07X
&VSwitchId=vsw-bp1s5fnvk4gn2tws03ziX
&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-bp17441ohwka0yuhx3h0
&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-bp1s5fnvk4gn2tws03ziX
&NetworkInterface. 1. SecurityGroupId=sg-bp15ed6xe1yxeycg7ov3
&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
&<Common request parameters>
通常のレスポンスの例
XML
形式
<CreateLaunchTemplateResponse>
<RequestId>04F0F334-1335-436C-A1D7-6C044FExxxxx</RequestId>
<LaunchTemplateId>lt-m5eiaupmvm2op9dxxxxx</LaunchTemplateId>
</CreateLaunchTemplateResponse>
JSON
形式
{
"LaunchTemplateId":"lt-m5eiaupmvm2op9dxxxxx",
"RequestId":"04F0F334-1335-436C-A1D7-6C044FExxxxx"
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
400 | InvalidRegion.NotExist | %s | 指定されたリージョンが存在しない場合に返されるエラーメッセージ。 |
403 | LaunchTemplateLimitExceed | %s | 起動テンプレートの数が上限に達したときに返されるエラーメッセージ。 |
403 | LaunchTemplateName.Duplicated | %s | 指定されたテンプレート名がすでに使用されている場合に返されるエラーメッセージ。 |
400 | MissingParameter | %s | 必要なパラメーターが指定されていない場合に返されるエラーメッセージ。 |
400 | InvalidParameter | %s | パラメーターが無効である場合に返されるエラーメッセージ。 |
400 | InvalidLaunchTemplateName.Malformed | The specified parameter LaunchTemplateName is not valid. | LaunchTemplateName パラメーターの指定値が無効な場合に返されるエラーメッセージ。 |
400 | InvalidDescription.Malformed | The specified parameter VersionDescription is not valid. | 指定されたテンプレートバージョンの説明の形式が無効な場合に返されるエラーメッセージ。 |
403 | InnerServiceFailed | %s | 内部サービスの呼び出しに失敗したときに返されるエラーメッセージ。 |
400 | InvalidUserData.SizeExceeded | %s | 指定されたカスタムデータのサイズが制限を超えたときに返されるエラーメッセージ。 |
400 | InvalidUserData.Base64FormatInvalid | %s | 指定されたテンプレートバージョンの説明形式が無効な場合に返されるエラーメッセージ。 |