すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:CreateLaunchTemplate

    ドキュメントセンター

    Elastic Compute Service:CreateLaunchTemplate

    最終更新日:Jul 03, 2026

    ECS インスタンスの起動テンプレートを作成します。起動テンプレートを使用すると、インスタンスを作成するたびに多数のパラメーターを設定する必要がなくなります。

    操作説明

    CreateLaunchTemplate を呼び出してテンプレートを作成すると、バージョン番号 1 のデフォルトバージョンが自動的に生成されます。その後、このテンプレートに基づいて複数のバージョンを作成できます (CreateLaunchTemplateVersion)。バージョン番号は 1 から順に増加します。インスタンスの作成時 ( RunInstances ) にテンプレートバージョンを指定しない場合、デフォルトバージョンが使用されます。

    起動テンプレートバージョンには、リージョン、イメージ ID、インスタンスタイプ、セキュリティグループ ID、パブリック帯域幅など、インスタンスを作成するための構成が含まれます。特定の構成がバージョンで指定されていない場合、インスタンスの作成時に指定する必要があります。

    この操作を呼び出す際は、以下の点にご注意ください:

    • 各アカウントはリージョンごとに最大 30 個の起動テンプレートを作成でき、各テンプレートには最大 30 個のバージョンを設定できます。

    • 起動テンプレートのほとんどのパラメーターはオプションです。テンプレートを作成する際、Alibaba Cloud はパラメーター値の存在や有効性を検証しません。パラメーター値の有効性は、インスタンスを作成する際にのみ検証されます。

    • 起動テンプレートで構成が指定されている場合、インスタンスの作成時 ( RunInstances ) にその構成を除外できません。たとえば、テンプレートで HostName=LocalHost が指定されており、RunInstances で HostName の値を空のままにした場合、インスタンスのホスト名は LocalHost のままです。HostName=LocalHost の構成をオーバーライドするには、RunInstances で HostName=MyHost または別の値をセットしてください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecs:CreateLaunchTemplate

    create

    *LaunchTemplate

    acs:ecs:{#regionId}:{#accountId}:launchtemplate/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

    cn-hangzhou
    TemplateTag

    array<object>

    任意

    起動テンプレート自体のタグキーと値のペア。

    説明

    現在、起動テンプレートのタグの作成とクエリは API オペレーションでのみ可能です。コンソールではこれらのタグの作成や表示はサポートされていません。

    object

    任意

    起動テンプレート自体のタグキーと値のペア。

    Key

    string

    任意

    起動テンプレートのタグキー。N の有効な値: 1～20。タグキーは空文字列にできません。タグキーは最大 128 文字で、aliyun または acs: で始めることはできません。タグキーに http:// または https:// を含めることはできません。

    TestKey
    Value

    string

    任意

    起動テンプレートのタグ値。N の有効な値: 1～20。タグ値は空文字列にできます。タグ値は最大 128 文字で、aliyun または acs: で始めることはできません。タグ値に http:// または https:// を含めることはできません。

    TestValue
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

    cn-hangzhou
    LaunchTemplateName

    string

    必須

    起動テンプレートの名前。名前は 2～128 文字で、英字で始まる必要があり、http:// または https:// で始めることはできません。名前には数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。

    testLaunchTemplateName
    VersionDescription

    string

    任意

    起動テンプレートバージョンの説明。説明は 2～256 文字で、http:// または https:// で始めることはできません。

    testVersionDescription
    ImageId

    string

    任意

    イメージ ID。 DescribeImages を呼び出して、利用可能なイメージリソースをクエリできます。

    win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd
    ImageOwnerAlias

    string

    任意

    イメージのソース。有効な値:

    • system: Alibaba Cloud が提供するパブリックイメージ。

    • self: 自分で作成したカスタムイメージ。

    • others: 別の Alibaba Cloud アカウントからの共有イメージ。

    • marketplace: Alibaba Cloud マーケットプレイス のイメージ。Alibaba Cloud マーケットプレイスイメージは、事前にサブスクライブすることなく直接使用できます。Alibaba Cloud マーケットプレイスイメージの請求明細はご自身でご確認ください。

    system
    PasswordInherit

    boolean

    任意

    イメージにプリセットされたパスワードを使用するかどうかを指定します。

    説明

    このパラメーターを使用する場合、Password パラメーターは空にする必要があります。使用するイメージにパスワードが設定されていることを確認してください。

    false
    InstanceType

    string

    任意

    インスタンスタイプ。詳細については、インスタンスファミリー を参照してください。 DescribeInstanceTypes を呼び出して、最新のインスタンスタイプリストをクエリすることもできます。

    ecs.g5.large
    SecurityGroupId

    string

    任意

    インスタンスが属するセキュリティグループの ID。同じセキュリティグループ内のインスタンスは相互に通信できます。1 つのセキュリティグループには最大 1,000 個のインスタンスを含めることができます。

    説明

    SecurityGroupId と SecurityGroupIds.N を同時に指定することはできません。

    sg-bp15ed6xe1yxeycg****
    VpcId

    string

    任意

    仮想プライベートクラウド (VPC) の ID。

    vpc-bp12433upq1y5scen****
    VSwitchId

    string

    任意

    vSwitch ID。VPC 接続インスタンスを作成する場合、このパラメーターは必須です。

    vsw-bp1s5fnvk4gn2tws0****
    InstanceName

    string

    任意

    インスタンスの名前。名前は 2～128 文字で、英字、数字、Unicode 文字カテゴリの文字 (中国語文字を含む) を含めることができます。名前にはコロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を含めることができます。デフォルト値はインスタンスの InstanceId です。

    複数の ECS インスタンスを作成する場合、連番のインスタンス名を指定できます。名前には角括弧 ([]) とカンマ (,) を含めることができます。詳細については、連番のインスタンス名またはホスト名の指定 を参照してください。

    k8s-node-[1,4]-alibabacloud
    Description

    string

    任意

    インスタンスの説明。説明は 2～256 文字で、http:// または https:// で始めることはできません。

    testECSDescription
    InternetMaxBandwidthIn

    integer

    任意

    最大インバウンドパブリック帯域幅。単位: Mbit/s。有効な値:

    • 購入したアウトバウンドパブリック帯域幅が 10 Mbit/s 以下の場合: 1～10。デフォルト値: 10。

    • 購入したアウトバウンドパブリック帯域幅が 10 Mbit/s を超える場合: 1～InternetMaxBandwidthOut の値。デフォルト値: InternetMaxBandwidthOut の値。

    10
    InternetMaxBandwidthOut

    integer

    任意

    最大アウトバウンドパブリック帯域幅。単位: Mbit/s。有効な値: 0～100。

    10
    HostName

    string

    任意

    Elastic Compute Service サーバーのホスト名。

    • ホスト名はピリオド (.) またはハイフン (-) で開始または終了できません。連続するピリオド (.) またはハイフン (-) を含めることはできません。

    • Windows インスタンス: ホスト名は 2～15 文字で、ピリオド (.) を含めることはできず、数字のみで構成することはできません。英字、数字、ハイフン (-) を含めることができます。

    • その他のインスタンス (Linux など): ホスト名は 2～64 文字です。複数のピリオド (.) を含めることができ、ピリオド間の各セグメントには英字、数字、ハイフン (-) を使用できます。

    testHostName
    ZoneId

    string

    任意

    インスタンスのゾーン ID

    cn-hangzhou-g
    SystemDisk.Category

    string

    任意

    システムディスクのカテゴリ。有効な値:

    • cloud: 基本ディスク。

    • cloud_efficiency: Ultra ディスク。

    • cloud_ssd: 標準 SSD。

    • cloud_essd: ESSD (エンタープライズ SSD)。SystemDisk.PerformanceLevel パラメーターを使用してディスクのパフォーマンスレベルを設定できます。

    • cloud_auto: ESSD AutoPL ディスク。

    • cloud_essd_entry: ESSD Entry ディスク。

    廃止された I/O 最適化されていないインスタンスタイプの場合、デフォルト値は cloud です。それ以外の場合、デフォルト値は cloud_efficiency です。

    cloud_ssd
    SystemDisk.Size

    integer

    任意

    システムディスクのサイズ。単位: GiB。有効な値:

    • cloud: 20～500。

    • その他のディスクカテゴリ: 20～2048。

    このパラメーターの値は max{20, ImageSize} 以上である必要があります。

    40
    SystemDisk.DiskName

    string

    任意

    システムディスクの名前。名前は 2～128 文字で、英字で始まる必要があり、http:// または https:// で始めることはできません。名前には数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。

    testSystemDiskName
    SystemDisk.Description

    string

    任意

    システムディスクの説明。説明は 2～256 文字で、http:// または https:// で始めることはできません。

    testSystemDiskDescription
    SystemDisk.Iops

    integer

    任意

    説明

    このパラメーターは招待プレビュー中であり、一般公開されていません。

    null
    SystemDisk.PerformanceLevel

    string

    任意

    システムディスクとして使用される ESSD のパフォーマンスレベル。有効な値:

    • PL0 (デフォルト): 1 つのディスクで最大 10,000 のランダム読み取り/書き込み IOPS を配信できます。

    • PL1: 1 つのディスクで最大 50,000 のランダム読み取り/書き込み IOPS を配信できます。

    • PL2: 1 つのディスクで最大 100,000 のランダム読み取り/書き込み IOPS を配信できます。

    • PL3: 1 つのディスクで最大 1,000,000 のランダム読み取り/書き込み IOPS を配信できます。

    ESSD パフォーマンスレベルの選択方法については、ESSD (エンタープライズ SSD) を参照してください。

    PL0
    SystemDisk.DeleteWithInstance

    boolean

    任意

    インスタンスのリリース時にシステムディスクをリリースするかどうかを指定します。有効な値:

    • true: インスタンスのリリース時にシステムディスクをリリースします。

    • false: インスタンスのリリース時にシステムディスクをリリースしません。

    デフォルト値: true。

    true
    SystemDisk.AutoSnapshotPolicyId

    string

    任意

    システムディスクに適用される自動スナップショットポリシーの ID。

    sp-gc7c37d4ylw7mtnk****
    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

    任意

    バースト機能を有効にするかどうかを指定します。有効な値:

    • true: バースト機能を有効にします。

    • false: バースト機能を有効にしません。

    true
    IoOptimized

    string

    任意

    インスタンスが I/O 最適化されているかどうかを指定します。有効な値:

    • none: I/O 最適化されていません。

    • optimized: I/O 最適化されています。

    optimized
    InstanceChargeType

    string

    任意

    インスタンスの支払い方法。有効な値:

    • PrePaid: サブスクリプション。このパラメーターを PrePaid に設定する場合、アカウントがクレジット払いをサポートしていることを確認してください。サポートしていない場合、InvalidPayMethod エラーが返されます。

    • PostPaid: 従量課金。

    PrePaid
    Period

    integer

    任意

    リソースのサブスクリプション期間。単位: 月。このパラメーターは InstanceChargeType が PrePaid に設定されている場合にのみ効果があり、必須です。有効な値: 1、2、3、4、5、6、7、8、9、12、24、36、48、60。

    1
    InternetChargeType

    string

    任意

    ネットワーク使用量の支払い方法。有効な値:

    • PayByBandwidth: 帯域幅課金。

    • PayByTraffic: トラフィック課金。

    説明

    トラフィック課金モードでは、ピークインバウンドおよびアウトバウンド帯域幅は、保証されたサービスメトリクスではなく帯域幅の上限として使用されます。リソース競合が発生した場合、ピーク帯域幅が制限される場合があります。ワークロードに帯域幅の保証が必要な場合は、帯域幅課金モードを使用してください。

    PayByTraffic
    EnableVmOsConfig

    boolean

    任意

    インスタンスのオペレーティングシステム構成を有効にするかどうかを指定します。

    説明

    このパラメーターは廃止予定です。互換性を高めるため、他のパラメーターを使用してください。

    false
    NetworkType

    string

    任意

    インスタンスのネットワークタイプ。有効な値:

    • classic: クラシックネットワーク。この機能は廃止されました。詳細については、廃止のお知らせ を参照してください。

    • vpc: VPC。

    vpc
    UserData

    string

    任意

    インスタンスのユーザーデータ。データは Base64 エンコードされている必要があります。生データの最大サイズは 32 KB です。

    ZWNobyBoZWxsbyBlY3Mh
    KeyPairName

    string

    任意

    キーペアの名前。

    • Windows インスタンスの場合、このパラメーターは無視されます。このパラメーターを指定しても、Password の内容のみが使用されます。

    • Linux インスタンスの場合、初期化時にパスワードベースのログインが無効になります。

    testKeyPairName
    RamRoleName

    string

    任意

    インスタンス RAM ロールの名前。RAM API ListRoles を呼び出して、作成済みのインスタンス RAM ロールをクエリできます。

    testRamRoleName
    AutoReleaseTime

    string

    任意

    自動リリース時間。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 初期化で時間を指定します。時間は協定世界時 (UTC) である必要があります。

    • 秒 (ss) の値が 00 でない場合、時間は自動的に現在の分 (mm) の開始に切り捨てられます。

    • 最も早いリリース時間は現在の時間から 30 分後です。

    • 最も遅いリリース時間は現在の時間から 3 年以内です。

    2018-01-01T12:05:00Z
    SpotStrategy

    string

    任意

    従量課金インスタンスのプリエンプションポリシー。このパラメーターは InstanceChargeType が PostPaid に設定されている場合に効果があります。有効な値:

    • NoSpot: 通常の従量課金インスタンスです。

    • SpotWithPriceLimit: ユーザー定義の最大時間単価を持つスポットインスタンスです。

    • SpotAsPriceGo: 購入時の市場価格が自動的に入札価格として使用されるスポットインスタンスです。

    NoSpot
    SpotPriceLimit

    number

    任意

    インスタンスの最大時間単価。このパラメーターは小数点以下 3 桁までサポートし、SpotStrategy が SpotWithPriceLimit に設定されている場合に効果があります。

    0.97
    SpotDuration

    integer

    任意

    スポットインスタンスの保護期間。単位: 時間。デフォルト値: 1。有効な値:

    • 1: スポットインスタンスの作成後、Alibaba Cloud は 1 時間以内にインスタンスが自動的にリリースされないことを保証します。1 時間の保護期間が終了すると、システムは入札価格と市場価格を比較し、リソースインベントリを確認して、インスタンスを保持するか自動リリースするかを決定します。

    • 0: スポットインスタンスの作成後、Alibaba Cloud はインスタンスが 1 時間実行されることを保証しません。システムは入札価格と市場価格を比較し、リソースインベントリを確認して、インスタンスを保持するか自動リリースするかを決定します。

    Alibaba Cloud はインスタンスがリリースされる 5 分前に ECS システムイベント通知を送信します。スポットインスタンスは秒単位で課金されます。予想されるタスク実行時間に基づいて適切な保護期間を選択してください。

    説明

    このパラメーターは SpotStrategy が SpotWithPriceLimit または SpotAsPriceGo に設定されている場合にのみ効果があります。

    1
    ResourceGroupId

    string

    任意

    インスタンス、ブロックストレージ、Elastic ネットワークインターフェイスコントローラー (NIC) が属するリソースグループの ID。

    rg-bp67acfmxazb4p****
    TemplateResourceGroupId

    string

    任意

    起動テンプレートが属するリソースグループの ID。

    rg-bp67acfmxazb4p****
    SecurityEnhancementStrategy

    string

    任意

    オペレーティングシステムのセキュリティ強化を有効にするかどうかを指定します。有効な値:

    • Active: セキュリティ強化を有効にします。この値はパブリックイメージにのみ適用されます。

    • Deactive: セキュリティ強化を無効にします。この値はすべてのイメージタイプに適用されます。

    Deactive
    PrivateIpAddress

    string

    任意

    インスタンスのプライベート IP アドレス。

    VPC 接続 ECS インスタンスにプライベート IP アドレスを指定する場合、IP アドレスは vSwitch (VSwitchId) のアイドル CIDR ブロックからのものである必要があります。

    10.1.**.**
    DeploymentSetId

    string

    任意

    デプロイメントセットの ID。

    ds-bp1brhwhoqinyjd6****
    Ipv6AddressCount

    integer

    任意

    プライマリ ENI に割り当てるランダムに生成された IPv6 アドレスの数。有効な値: 1～10。

    1
    DataDisk

    array<object>

    任意

    データディスク情報のリスト。

    object

    任意

    データディスク情報のリスト。

    PerformanceLevel

    string

    任意

    データディスクとして使用される ESSD のパフォーマンスレベル。N の値は DataDisk.N.Category=cloud_essd の値と同じである必要があります。有効な値:

    • PL0: 1 つのディスクで最大 10,000 のランダム読み取り/書き込み IOPS を配信できます。

    • PL1 (デフォルト): 1 つのディスクで最大 50,000 のランダム読み取り/書き込み IOPS を配信できます。

    • PL2: 1 つのディスクで最大 100,000 のランダム読み取り/書き込み IOPS を配信できます。

    • PL3: 1 つのディスクで最大 1,000,000 のランダム読み取り/書き込み IOPS を配信できます。

    ESSD パフォーマンスレベルの選択方法については、ESSD (エンタープライズ SSD) を参照してください。

    PL1
    Description

    string

    任意

    データディスクの説明。説明は 2～256 文字で、http:// または https:// で始めることはできません。

    testDataDiskDescription
    SnapshotId

    string

    任意

    データディスク N の作成に使用されるスナップショットの ID。N の有効な値: 1～16。DataDisk.N.SnapshotId を指定すると、DataDisk.N.Size パラメーターは無視されます。作成されるディスクの実際のサイズは、指定されたスナップショットのサイズになります。

    説明

    2013 年 7 月 15 日以前に作成されたスナップショットは使用できません。そのようなリクエストは拒否されます。

    s-bp17441ohwka0yuh****
    Size

    integer

    任意

    データディスク N のサイズ。N の有効な値: 1～16。単位: GiB。有効な値:

    • cloud: 5～2000。

    • cloud_efficiency: 20～32768。

    • cloud_ssd: 20～32768。

    • cloud_essd: 有効値の範囲は DataDisk.N.PerformanceLevel の値によって異なります。

      • PL0: 1～32768。

      • PL1: 20～32768。

      • PL2: 461～32768。

      • PL3: 1261～32768。

    • cloud_auto: 1～32,768。

    • cloud_essd_entry: 10～32,768。

    このパラメーターの値は SnapshotId で指定されたスナップショットのサイズ以上である必要があります。

    2000
    Device

    string

    任意

    データディスクのマウントポイント。命名規則はアタッチされたデータディスクの数によって異なります:

    • 1～25 個のデータディスク: /dev/xvd[b-z]

    • 25 個を超えるデータディスク: /dev/xvd[aa-zz]。たとえば、26 番目のデータディスクは /dev/xvdaa、27 番目のデータディスクは /dev/xvdab という名前になります。

    説明

    このパラメーターはフルイメージ (マシン全体イメージ) シナリオのみを対象としています。このパラメーターをフルイメージ内のデータディスクのマウントポイントに設定し、対応する DataDisk.N.Size および DataDisk.N.Category パラメーターを変更して、フルイメージ内のデータディスクのディスクカテゴリとサイズを変更できます。

    /dev/xvdb

    DiskName

    string

    任意

    データディスクの名前。名前は 2～128 文字で、英字で始まる必要があり、http:// または https:// で始めることはできません。名前には数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。

    testDataDiskName
    Category

    string

    任意

    データディスク N のカテゴリ。有効な値:

    • cloud_efficiency: Ultra ディスク。

    • cloud_ssd: 標準 SSD。

    • cloud_essd: ESSD (エンタープライズ SSD)。

    • cloud: 基本ディスク。

    • cloud_auto: ESSD AutoPL ディスク。

    • cloud_regional_disk_auto: リージョナル ESSD。

    • cloud_essd_entry: ESSD Entry ディスク。
      説明

      cloud_essd_entry の値は InstanceType が ecs.u1 または ecs.e インスタンスファミリーに設定されている場合にのみサポートされます。

    • elastic_ephemeral_disk_standard: エラスティック一時ディスク - 標準。

    • elastic_ephemeral_disk_premium: エラスティック一時ディスク - Premium エディション。

    I/O 最適化インスタンスの場合、デフォルト値は cloud_efficiency です。非 I/O 最適化インスタンスの場合、デフォルト値は cloud です。 デフォルト値の説明:

    • InstanceType が廃止された I/O 最適化されていないインスタンスタイプの場合、このパラメーターのデフォルト値は cloud です。

    • その他の場合、デフォルト値は cloud_efficiency です。

    cloud_ssd
    DeleteWithInstance

    boolean

    任意

    インスタンスのリリース時にデータディスクをリリースするかどうかを指定します。有効な値:

    • true: インスタンスのリリース時にデータディスクをリリースします。

    • false: インスタンスのリリース時にデータディスクをリリースしません。

    デフォルト値: true。

    true
    Encrypted

    string

    任意

    データディスクを暗号化するかどうかを指定します。

    false
    AutoSnapshotPolicyId

    string

    任意

    データディスクに適用される自動スナップショットポリシーの ID。

    sp-m5e7fa9ute44ssa****
    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

    任意

    バースト機能を有効にするかどうかを指定します。有効な値:

    • true: バースト機能を有効にします。

    • false: バースト機能を有効にしません。

    true
    KMSKeyId

    string

    任意

    データディスクの KMS キー ID。 [_single.params

    0e478b7a-4262-4802-b8cb-00d****
    NetworkInterface

    array<object>

    任意

    ネットワークインターフェイスコントローラー (NIC) の情報。

    object

    任意

    ネットワークインターフェイスコントローラー (NIC) の情報。

    VSwitchId

    string

    任意

    ネットワークインターフェイスコントローラー (NIC) の vSwitch ID。

    以下の点にご注意ください:

    • N の有効な値: 1～2。N を 1 に設定すると、プライマリまたはセカンダリ NIC を設定できます。N を 2 に設定すると、プライマリ NIC 1 つとセカンダリ NIC 1 つを設定する必要があります。

    • NetworkInterface.N.InstanceType が Primary に設定されている場合、このパラメーターは必須です。このパラメーターは VSwitchId と同じ効果がありますが、このパラメーターと VSwitchId を同時に指定することはできません。

    • NetworkInterface.N.InstanceType が Secondary に設定されているか空の場合、このパラメーターはオプションです。デフォルト値: ECS インスタンスの vSwitch。

    vsw-bp1s5fnvk4gn2tws0****
    NetworkInterfaceName

    string

    任意

    ネットワークインターフェイスコントローラー (NIC) の名前。

    以下の点にご注意ください:

    • N の有効な値: 1～2。N を 1 に設定すると、プライマリまたはセカンダリ NIC を設定できます。N を 2 に設定すると、プライマリ NIC 1 つとセカンダリ NIC 1 つを設定する必要があります。

    • NetworkInterface.N.InstanceType が Primary に設定されている場合、このパラメーター

    testEniName
    Description

    string

    任意

    The description of the secondary network interface controller (NIC). The description must be 2 to 256 characters in length and cannot start with http:// or https://. The value of N in NetworkInterface.N cannot be greater than 1.

    testEniDescription
    SecurityGroupId

    string

    任意

    The ID of the security group to which the network interface controller (NIC) belongs.

    Take note of the following items:

    • Valid values of N: 1 to 2. If you set N to 1, you can configure a primary or secondary NIC. If you set N to 2, you must configure one primary NIC and one secondary NIC.

    • If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter. This parameter has the same effect as SecurityGroupId, but you cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupIds.N.

    • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. Default value: the security group of the ECS instance.

    sg-bp15ed6xe1yxeycg****
    PrimaryIpAddress

    string

    任意

    Adds a network interface controller (NIC) and sets the primary IP address.

    Take note of the following items:

    • Valid values of N: 1 to 2.

      • If you set N to 1, you can configure a primary or secondary NIC. If the Amount parameter is set to a value greater than 1 and you configure a primary NIC with this parameter specified, consecutive primary IP addresses starting from the specified IP address are allocated to multiple ECS instances in batch. In this case, you cannot attach a secondary NIC to the instances.

      • If you set N to 2, you must configure one primary NIC and one secondary NIC. If the Amount parameter is set to a value greater than 1 and this parameter is specified for the primary NIC, you cannot configure a secondary NIC (that is, you cannot set NetworkInterface.2.InstanceType=Secondary).

    • If NetworkInterface.N.InstanceType is set to Primary, this parameter has the same effect as PrivateIpAddress, but you cannot specify both this parameter and PrivateIpAddress.

    • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter specifies the primary IP address of the secondary NIC. By default, an IP address is randomly selected from the vSwitch CIDR block to which the NIC belongs.

    説明

    When you create an ECS instance, you can attach up to one secondary NIC. After the instance is created, you can invoke CreateNetworkInterface and AttachNetworkInterface to attach more secondary NICs.

    192.168.**.**
    SecurityGroupIds

    array

    任意

    The IDs of one or more security groups to which the network interface controller (NIC) belongs.

    • The first N has a valid value range of 1 to 2. If you set N to 1, you can configure a primary or secondary NIC. If you set N to 2, you must configure one primary NIC and one secondary NIC.

    • The second N specifies one or more security group IDs. The valid value range of N depends on the maximum number of security groups to which an instance can belong. For more information, see Security group limits.

    Take note of the following items:

    • If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter or NetworkInterface.N.SecurityGroupId. This parameter has the same effect as SecurityGroupIds.N, but you cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupId.

    • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. Default value: the security group of the ECS instance.

    sg-bp67acfmxazb4p****

    string

    任意

    The IDs of one or more security groups to which the network interface controller (NIC) belongs.

    • The first N has a valid value range of 1 to 2. If you set N to 1, you can configure a primary or secondary NIC. If you set N to 2, you must configure one primary NIC and one secondary NIC.

    • The second N specifies one or more security group IDs. The valid value range of N depends on the maximum number of security groups to which an instance can belong. For more information, see Security group limits.

    Take note of the following items:

    • If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter or NetworkInterface.N.SecurityGroupId. This parameter has the same effect as SecurityGroupIds.N, but you cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupId.

    • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. Default value: the security group of the ECS instance.

    sg-bp67acfmxazb4p****
    InstanceType

    string

    任意

    The type of the network interface controller (NIC). Valid values of N: 1 to 2. If you set N to 1, you can configure a primary or secondary NIC. If you set N to 2, you must configure one primary NIC and one secondary NIC.

    Valid values:

    • Primary: primary NIC.

    • Secondary: secondary NIC.

    Default value: Secondary.

    Secondary
    NetworkInterfaceTrafficMode

    string

    任意

    The communication mode of the primary ENI. Valid values:

    • Standard: uses the TCP communication mode.

    • HighPerformance: enables the Elastic RDMA Interface (ERI) and uses the RDMA communication mode.

    Standard
    DeleteOnRelease

    boolean

    任意

    Specifies whether to retain the ENI when the instance is released. Valid values:

    • true: does not retain the ENI.

    • false: retains the ENI.

    Default value: true.

    説明

    This parameter takes effect only for secondary ENIs.

    true
    Tag

    array<object>

    任意

    The tags for instances, disks, and primary ENIs created from this template version.

    Scenarios

    After you call CreateLaunchTemplate to create a template, the auto-generated default version uses these tags to tag instances, disks, and primary ENIs when you create instances.

    object

    任意

    The tags for instances, disks, and primary ENIs created from this template version.

    Key

    string

    任意

    The tag key for instances, disks, and primary ENIs created from this template version. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with aliyun or acs:. The tag key cannot contain http:// or https://.

    TestKey
    Value

    string

    任意

    The tag value for instances, disks, and primary ENIs created from this template version. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain http:// or https://.

    TestValue
    SecurityGroupIds

    array

    任意

    The IDs of one or more security groups to which the instance belongs. The valid value range of N depends on the maximum number of security groups to which an instance can belong. For more information, see Limits.

    説明

    You cannot specify both SecurityGroupId and SecurityGroupIds.N.

    sg-bp15ed6xe1yxeycg7****

    string

    任意

    The IDs of one or more security groups to which the instance belongs. The valid value range of N depends on the maximum number of security groups to which an instance can belong. For more information, see Limits.

    説明

    You cannot specify both SecurityGroupId and SecurityGroupIds.N.

    sg-bp15ed6xe1yxeycg7****
    SystemDisk.Encrypted

    string

    任意

    Specifies whether to encrypt the system disk. Valid values:

    • true: encrypts the system disk.

    • false: does not encrypt the system disk.

    Default value: false.

    説明

    Zone D in Hong Kong (China) and Zone A in Singapore do not support system disk encryption when you create instances.

    false
    DeletionProtection

    boolean

    任意

    The release protection attribute of the instance. Specifies whether the instance can be released from the console or by calling DeleteInstance. Valid values:

    • true: enables release protection.

    • false: disables release protection.

    Default value: false.

    説明

    This attribute applies only to pay-as-you-go instances. It can only restrict manual release operations and does not affect system-initiated releases.

    false
    CreditSpecification

    string

    任意

    The running mode of the burstable instance. Valid values:

    Standard
    AutoRenew

    boolean

    任意

    Specifies whether to enable auto-renewal. Valid values:

    • true: enables auto-renewal.

    • false: does not enable auto-renewal.

    Default value: false.

    説明

    This parameter takes effect only when InstanceChargeType is set to PrePaid.

    true
    AutoRenewPeriod

    integer

    任意

    The auto-renewal period. Valid values:

    If PeriodUnit is set to Month: 1, 2, 3, 6, 12, 24, 36, 48, and 60.

    Default value: 1.

    1
    PeriodUnit

    string

    任意

    The unit of the subscription billable methods duration. Valid values:

    Month (default).

    Month
    HttpEndpoint

    string

    任意

    Specifies whether to enable the access channel for instance metadata. Valid values:

    • enabled: enables the access channel.

    • disabled: disables the access channel.

    Default value: enabled.

    説明

    For more information about instance metadata, see Overview of ECS instance metadata.

    enabled
    HttpTokens

    string

    任意

    Specifies whether to forcefully use the security-hardened mode (IMDSv2) to access instance metadata. Valid values:

    • optional: does not forcefully use the security-hardened mode.

    • required: forcefully uses the security-hardened mode. After you set this value, instance metadata cannot be accessed in normal mode.

    Default value: optional.

    説明

    For more information about the modes for Instance metadata overview

    optional
    HttpPutResponseHopLimit

    integer

    任意

    説明

    This parameter is not available for use.

    3
    SystemDisk.KMSKeyId

    string

    任意

    The KMS key ID of the system disk.

    0e478b7a-4262-4802-b8cb-00d3fb40****
    ImageOptions

    object

    任意

    The image-related property information.

    LoginAsNonRoot

    boolean

    任意

    Indicates whether the instance that uses this image supports logon with the ecs-user account. Valid values:

    • true: supported.

    • false: not supported.

    false
    SecurityOptions

    object

    任意

    The security options.

    TrustedSystemMode

    string

    任意

    The trusted system mode. Set the value to vTPM.

    The following instance families support trusted system mode:

    • g7, c7, and r7.

    • Enhanced instance families (g7t, c7t, and r7t).

    When you create ECS instances of the preceding instance types, you must configure this parameter. Take note of the following items:

    • To use Alibaba Cloud Trusted System, set this parameter to vTPM. Then, Alibaba Cloud Trusted System performs trusted verification when the instance starts.

    • If you do not use Alibaba Cloud Trusted System, you do not need to configure this parameter. However, if the ECS instance that you create uses the Enclave-based confidential computing pattern (SecurityOptions.ConfidentialComputingMode=Enclave), the trusted system is also enabled for the instance.

    • When you use OpenAPI to create a trusted ECS instance, you can only invoke RunInstances. CreateInstance does not support the SecurityOptions.TrustedSystemMode parameter.

    説明

    If you specify the instance as a trusted instance during creation, you can replace the system disk only with an image that supports the trusted system.

    For more information about the trusted system, see Overview of trusted features for security-enhanced instances.

    vTPM

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    LaunchTemplateId

    string

    The launch template ID.

    lt-m5eiaupmvm2op9d****
    RequestId

    string

    リクエスト ID

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    LaunchTemplateVersionNumber

    integer

    The launch template version number.

    20

    例

    成功レスポンス

    JSONJSON

    {
  "LaunchTemplateId": "lt-m5eiaupmvm2op9d****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "LaunchTemplateVersionNumber": 20
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidRegion.NotExist %s
    400 MissingParameter %s
    400 InvalidParameter %s
    400 InvalidLaunchTemplateName.Malformed The specified parameter LaunchTemplateName is not valid.
    400 InvalidDescription.Malformed The specified parameter "VersionDescription" is not valid.
    400 InvalidUserData.SizeExceeded %s
    400 InvalidUserData.Base64FormatInvalid %s
    400 Duplicate.TagKey The Tag.N.Key contain duplicate key.
    400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid.
    400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid.
    400 InvalidHostName.Malformed The specified parameter "HostName" is not valid.
    400 InvalidParams.CreateEniParams %s
    500 InternalError The request processing has failed due to some unknown error.
    403 LaunchTemplateLimitExceed %s
    403 LaunchTemplateName.Duplicated %s
    403 QuotaExceed.Tags %s
    404 InvalidResourceGroup.NotFound The ResourceGroup provided does not exist in our records.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。