Create stack#

スタックを作成します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://orchestration.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://orchestration.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

POST

/v1/{tenant_id}/stacks

HTTPステータスコード#

正常時:201

エラー時:400, 401, 409

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
tenant_id path string 必須 プロジェクトID
disable_rollback body boolean 任意 スタック作成に失敗したときに、スタックに含まれる作成済みのリソースを削除する場合に「false」を指定します。
省略したときの値は「true」です。
environment body object 任意 スタックの環境情報(JSON形式)
environment_files body object 任意 filesに含まれている環境ファイルの名前のリスト
files body object 任意 ファイル名とファイル内容のマップ
テンプレートで組み込み関数 get_fileを使用する場合に指定します。
リクエストボディのJSON形式が正しくなるように、必要に応じてファイル内容に含まれる文字をエスケープして指定します。
例えば、ダブルクォーテーション (")を「\"」に、改行を「\n」に置換して指定します。
parameters body object 任意 テンプレートに渡す入力パラメータ
各キーと値のペアはパラメータとその引数です。
stack_name body string 必須 作成するスタックの名前
半角英数字、アンダースコア(_)、ハイフン(-)、ピリオド(.)で構成される先頭英字の文字列を指定します。最大長は255文字です。256文字目以降は無視されます。
tags body string 任意 スタックに関連付けるタグ
コンマで区切られます。
template body object 任意 テンプレートの文字列
リクエストボディのJSON形式が正しくなるように、必要に応じてテンプレートに含まれる文字をエスケープして指定します。
例えば、ダブルクォーテーション (")を「\"」に、改行を「\n」に置換して指定します。
timeout_mins body integer 60
任意
タイムアウト値(分単位)

レスポンスボディ(正常系)の説明#

名前 Type Description
stack object スタックのオブジェクト
id string スタックのUUID
links array スタックのURLのリスト
各URLはhrefとrelのキーペアを含めるJSONのオブジェクトです。relは対象のスタックとの関係を表示します。selfの場合は、対象スタック自身です。

リクエスト例#

{
    "files": {},
    "disable_rollback": true,
    "parameters": {
        "flavor": "m1.heat"
    },
    "stack_name": "teststack",
    "template": {
        "heat_template_version": "2013-05-23",
        "description": "Simple template to test heat commands",
        "parameters": {
            "flavor": {
                "default": "m1.tiny",
                "type": "string"
            }
        },
        "resources": {
            "hello_world": {
                "type": "OS::Nova::Server",
                "properties": {
                    "key_name": "heat_key",
                    "flavor": {
                        "get_param": "flavor"
                    },
                    "image": "40be8d1a-3eb9-40de-8abd-43237517384f",
                    "user_data": "#!/bin/bash -xv\necho \"hello world\" > /root/hello-world.txt\n"
                }
            }
        }
    },
    "timeout_mins": 60
}

レスポンス例#

{
    "stack": {
        "id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
        "links": [
            {
                "href": "http://192.168.123.200:8004/v1/eb1c63a4f77141548385f113a28f0f52/stacks/teststack/3095aefc-09fb-4bc7-b1f0-f21a304e864c",
                "rel": "self"
            }
        ]
    }
}