すべてのプロダクト
Search

このプロダクト

    :CreateStack

    ドキュメントセンター

    :CreateStack

    最終更新日:Jun 04, 2026

    ROS テンプレートからスタックを作成し、リソースグループをデプロイします。

    操作説明

    スタックは ROS リソースの管理単位です (概要)。リソースグループをデプロイするには、スタックを作成します。制限事項は以下のとおりです。

    • 各 Alibaba Cloud アカウントで作成できるスタック数は最大 200 個です。

    • 各スタックに含めることができるリソース数は最大 200 個です。

    以下の例では、中国 (杭州) リージョンに MyStack という名前のスタックを作成し、TemplateBody を {"ROSTemplateFormatVersion":"2015-09-01"} に設定しています。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ros:CreateStack

    create

    *Stack

    acs:ros:{#regionId}:{#accountId}:stack/*

    Template

    acs:ros:{#regionId}:{#accountId}:template/{#TemplateId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DisableRollback

    boolean

    任意

    スタック作成が失敗した場合にロールバックを無効にするかどうかを指定します。

    有効な値：

    • true：ロールバックを無効にします。

    • false（デフォルト）：ロールバックを有効にします。

    false
    TemplateBody

    string

    任意

    テンプレート本文。長さ：1～524,288 バイト。コンテンツが大きい場合は、URL が長くなることでリクエストが失敗することを避けるため、HTTP POST メソッドで Body パラメーター を使用してください。

    説明

    次のパラメーターのうち、いずれか 1 つのみを指定する必要があります：TemplateBody、TemplateURL、TemplateId、または TemplateScratchId。

    {"ROSTemplateFormatVersion":"2015-09-01"}
    StackPolicyURL

    string

    任意

    スタックポリシーファイルの URL。Web サーバー（HTTP または HTTPS）上のファイル、または OSS バケット内のファイル（例：oss://ros/stack-policy/demo または oss://ros/stack-policy/demo?RegionId=cn-hangzhou）を指している必要があります。ファイルの最大サイズは 16,384 バイトです。URL に OSS のリージョンが指定されていない場合、RegionId パラメーターの値が使用されます。

    説明

    次のパラメーターのうち、いずれか 1 つのみを指定できます：StackPolicyBody または StackPolicyURL。

    URL の最大長は 1,350 バイトです。

    oss://ros-stack-policy/demo
    TimeoutInMinutes

    integer

    任意

    スタック作成のタイムアウト時間。単位：分。

    • デフォルト値：60

    • 有効な値：10～1440

    10
    StackPolicyBody

    string

    任意

    スタックポリシー本文。長さ：1～16,384 バイト。

    説明

    次のパラメーターのうち、いずれか 1 つのみを指定できます：StackPolicyBody または StackPolicyURL。

    {"Statement": [{"Action": "Update:*", "Resource": "*", "Effect": "Allow", "Principal": "*"}]}
    StackName

    string

    必須

    スタック名。最大長：255 文字。英字で始まり、英字、数字、ハイフン (-)、およびアンダースコア (_) を含めることができます。

    MyStack
    RegionId

    string

    必須

    スタックのリージョン ID。DescribeRegions を呼び出して、利用可能なリージョンを照会できます。

    cn-hangzhou
    ClientToken

    string

    任意

    リクエストのべき等性を保証します。クライアント側で生成され、グローバルに一意である必要があります。最大長：64 文字。英字、数字、ハイフン (-)、およびアンダースコア (_) を含めることができます。

    べき等性の保証方法。

    123e4567-e89b-12d3-a456-42665544****
    TemplateURL

    string

    任意

    テンプレート本文ファイルの URL。Web サーバー（HTTP または HTTPS）上のテンプレート、または OSS バケット内のテンプレート（例：oss://ros/stack-policy/demo または oss://ros/stack-policy/demo?RegionId=cn-hangzhou）を指している必要があります。テンプレートの最大サイズは 524,288 バイトです。URL に OSS のリージョンが指定されていない場合、RegionId パラメーターの値が使用されます。

    説明

    次のパラメーターのうち、いずれか 1 つのみを指定する必要があります：TemplateBody、TemplateURL、TemplateId、または TemplateScratchId。

    oss://ros-template/demo
    RamRoleName

    string

    任意

    RAM ロール名。ROS はこのロールを偽装してスタックを作成し、ユーザーに代わって API を呼び出すためにロールの認証情報を使用します。ROS はスタック操作時に常にこのロールを使用します。ユーザーがスタックを操作する権限を持っている場合、明示的なロール権限がなくても ROS はこのロールを使用し、最小権限アクセスを保証します。スタックロールの使用。

    指定しない場合、ROS は現在スタックに関連付けられているロールを使用します。関連付けられたロールが存在しない場合は、ご利用のアカウントから生成された一時認証情報を使用します。

    RAM ロール名の最大長は 64 文字です。

    test-role
    DeletionProtection

    string

    任意

    スタックの削除保護を有効にするかどうかを指定します。有効な値：

    • Enabled：削除保護を有効にします。

    • Disabled（デフォルト）：削除保護を無効にします。ROS コンソールまたは DeleteStack API を呼び出してスタックを削除できます。

    説明

    ネストされたスタックの削除保護は、そのルートスタックと同じになります。

    Enabled
    CreateOption

    string

    任意

    スタック作成後のスタックに関するオプション。有効な値：

    • KeepStackOnCreationComplete（デフォルト）：スタック作成後にスタックとそのリソースを保持します。スタックは、作成可能なスタック総数のクォータを占有します。

    • AbandonStackOnCreationComplete：スタック作成後にスタックを削除しますが、すべてのリソースは保持します。スタックは、作成可能なスタック総数のクォータを占有しません。スタックの作成に失敗した場合は、スタックが保持されます。

    • AbandonStackOnCreationRollbackComplete：スタックがロールバックされた後にスタックを削除します。スタックは、作成可能なスタック総数のクォータを占有しません。その他のロールバックシナリオでは、スタックが保持されます。

    • ManuallyPay：スタック作成時に、使用されるサブスクリプションリソースの支払いを手動で行う必要があります。手動支払いをサポートするリソースタイプは次のとおりです：ALIYUN::ECS::InstanceGroup、ALIYUN::RDS::DBInstance、ALIYUN::SLB::LoadBalancer、ALIYUN::VPC::EIP、および ALIYUN::VPC::VpnGateway。

    • RetryOnNoStock：リソース作成が在庫不足により失敗した場合、自動的にリトライします。現在、リトライをサポートするリソースタイプは ALIYUN::RDS::DBInstance です。

    説明

    次のパラメーターのうち、いずれか 1 つのみを指定できます：CreateOption または CreateOptions。

    KeepStackOnCreationComplete
    CreateOptions

    array

    任意

    スタックの作成オプション。

    string

    任意

    スタックの作成オプション N。有効な値：

    • KeepStackOnCreationComplete（デフォルト）：スタック作成後にスタックとそのリソースを保持します。スタックは、作成可能なスタック総数のクォータを占有します。

    • AbandonStackOnCreationComplete：スタック作成後にスタックを削除しますが、すべてのリソースは保持します。スタックは、作成可能なスタック総数のクォータを占有しません。スタックの作成に失敗した場合は、スタックが保持されます。

    • AbandonStackOnCreationRollbackComplete：スタック作成失敗によるロールバック後にスタックを削除します。スタックは、作成可能なスタック総数のクォータを占有しません。その他のロールバックシナリオでは、スタックが保持されます。

    • ManuallyPay：スタック作成時に、使用されるサブスクリプションリソースの支払いを手動で行う必要があります。手動支払いをサポートするリソースタイプは次のとおりです：ALIYUN::ECS::InstanceGroup、ALIYUN::RDS::DBInstance、ALIYUN::SLB::LoadBalancer、ALIYUN::VPC::EIP、および ALIYUN::VPC::VpnGateway。

    • RetryOnNoStock：リソース作成が在庫不足により失敗した場合、自動的にリトライします。現在、リトライをサポートするリソースタイプは ALIYUN::RDS::DBInstance です。

    説明

    • 次のパラメーターのうち、いずれか 1 つのみを指定できます：CreateOption または CreateOptions。

    • 作成オプションは繰り返し指定できません。KeepStackOnCreationComplete オプションは、AbandonStackOnCreationComplete および AbandonStackOnCreationRollbackComplete オプションと相互排他です。

    • N の最大値は 4 です。

    KeepStackOnCreationComplete
    TemplateId

    string

    任意

    テンプレート ID。このパラメーターは、共有テンプレートおよびプライベートテンプレートに適用されます。

    説明

    次のパラメーターのうち、いずれか 1 つのみを指定する必要があります：TemplateBody、TemplateURL、TemplateId、または TemplateScratchId。

    5ecd1e10-b0e9-4389-a565-e4c15efc****
    TemplateVersion

    string

    任意

    テンプレートのバージョン。このパラメーターは、TemplateId を指定した場合にのみ有効になります。

    v1
    Parameters

    array<object>

    任意

    テンプレートで定義されたパラメーター。

    object

    任意

    ParameterKey

    string

    必須

    テンプレートで定義されたパラメーター N の名前。パラメーターの名前と値を指定しない場合、ROS はテンプレート内のデフォルト値を使用します。

    N の最大値は 200 です。名前は 1～128 文字で、aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。

    説明

    Parameters は省略可能なパラメーターです。Parameters を指定するには、Parameters.N.ParameterKey および Parameters.N.ParameterValue の両方を指定する必要があります。

    InstanceId
    ParameterValue

    string

    必須

    テンプレートで定義されたパラメーター N の値。

    N の最大値は 200 です。値は 0～128 文字で、aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。

    説明

    Parameters は省略可能なパラメーターです。Parameters を指定するには、Parameters.N.ParameterKey および Parameters.N.ParameterValue の両方を指定する必要があります。

    i-xxxxxx
    NotificationURLs

    array

    任意

    スタックイベントのコールバック URL。有効な値：

    • HTTP POST URL。各 URL の長さは最大 1,024 バイトです。

    • スタックステータスが変化した際に EventBridge が通知を受信します。EventBridge コンソールでイベント情報を確認できます。

    説明

    この機能は、以下のリージョンでサポートされています：中国 (杭州)、中国 (上海)、中国 (北京)、中国 (香港)、および中国 (張家口)。

    N の最大値は 5 です。スタックのステータスが変化すると、ROS は指定された URL に通知を送信します。スタックでロールバックが有効になっている場合、CREATE_FAILED または UPDATE_FAILED イベント発生時には通知を送信しませんが、CREATE_ROLLBACK または ROLLBACK イベント発生時には通知を送信します。IN_PROGRESS イベント発生時には通知を送信しません。スタックが Outputs を定義しているかどうかに関係なく、ROS は常に通知を送信します。以下のサンプルコードは、イベント通知の内容例を示しています。

    {
   "Outputs": [
       {
           "Description": "No description given",
           "OutputKey": "InstanceId",
           "OutputValue": "i-xxx"
       }
   ],
   "StackId": "80bd6b6c-e888-4573-ae3b-93d29113****",
   "StackName": "test-notification-url",
   "Status": "CREATE_COMPLETE"
}

    http://my-site.com/ros-event

    string

    任意

    スタックイベント N のコールバック URL。有効な値：

    • HTTP POST URL。各 URL の長さは最大 1,024 バイトです。

    • スタックステータスが変化した際に EventBridge が通知を受信します。EventBridge コンソールでイベント情報を確認できます。

    説明

    この機能は、以下のリージョンでサポートされています：中国 (杭州)、中国 (上海)、中国 (北京)、中国 (香港)、および中国 (張家口)。

    N の最大値は 5 です。スタックのステータスが変化すると、ROS は指定された URL に通知を送信します。スタックでロールバックが有効になっている場合、CREATE_FAILED または UPDATE_FAILED イベント発生時には通知を送信しませんが、CREATE_ROLLBACK または ROLLBACK イベント発生時には通知を送信します。IN_PROGRESS イベント発生時には通知を送信しません。スタックが Outputs を定義しているかどうかに関係なく、ROS は常に通知を送信します。以下のサンプルコードは、イベント通知の内容例を示しています。

    {
   "Outputs": [
       {
           "Description": "No description given",
           "OutputKey": "InstanceId",
           "OutputValue": "i-xxx"
       }
   ],
   "StackId": "80bd6b6c-e888-4573-ae3b-93d29113****",
   "StackName": "test-notification-url",
   "Status": "CREATE_COMPLETE"
}

    http://example.com/ros-event
    Tags

    array<object>

    任意

    スタックのタグ。

    object

    任意

    Key

    string

    必須

    スタックのタグ N のキー。

    有効な値：1～20。

    説明

    • Tags は省略可能なパラメーターです。Tags を指定するには、Tags.N.Key を指定する必要があります。

    • スタックタグは、タグ付けをサポートする各リソースに伝播します。タグの伝播。

    usage
    Value

    string

    任意

    スタックのタグ N の値。

    有効な値：1～20。

    説明

    スタックのタグは、スタック内のタグ機能をサポートする各リソースに伝播します。タグの伝播。

    test
    ResourceGroupId

    string

    任意

    リソースグループの ID。指定しない場合、スタックはデフォルトリソースグループに追加されます。

    リソースグループとは。

    rg-acfmxazb4ph6aiy****
    Parallelism

    integer

    任意

    リソースに対する同時実行操作の最大数。

    デフォルトでは、このパラメーターは空です。0 以上の整数を設定できます。

    説明

    • 0 より大きい整数を設定した場合、その整数が使用されます。0 を設定するか空のままにした場合、ROS スタックには制限が課されず、Terraform スタックには Terraform のデフォルト値（通常は 10）が使用されます。

    • 特定の値を設定した場合、ROS はその値をスタックに関連付けます。この値は、更新などの後続のスタック操作に影響します。

    1
    TemplateScratchId

    string

    任意

    リソースシナリオの ID。

    リソースシナリオ ID を取得するには、ListTemplateScratches を呼び出してください。

    説明

    次のパラメーターのうち、いずれか 1 つのみを指定する必要があります：TemplateBody、TemplateURL、TemplateId、または TemplateScratchId。

    ts-aa9c62feab844a6b****
    TemplateScratchRegionId

    string

    任意

    リソースシナリオのリージョン ID。デフォルト値：RegionId の値。

    DescribeRegions を呼び出して、利用可能なリージョンを照会できます。

    cn-hangzhou

    リクエスト共通パラメーターについては、「共通パラメーター」をご参照ください。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    B288A0BE-D927-4888-B0F7-B35EF84B6E6F
    StackId

    string

    スタック ID。

    4a6c9851-3b0f-4f5f-b4ca-a14bf691****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
  "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****"
}

    エラーコード

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

    変更履歴

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