Update stack (PATCH)#

スタックを部分的に更新します。

APIエンドポイント#

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

HTTPメソッドとURI#

PATCH

/v1/{tenant_id}/stacks/{stack_name}/{stack_id}

HTTPステータスコード#

正常時：202

エラー時：400, 401, 404, 500

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

名前 In Type デフォルト値
/必須指定		 Description
tenant_id path string 必須 プロジェクトID
stack_name path string 必須 スタック名
stack_id path string 必須 スタックのUUID
clear_parameters body array 任意 スタックから削除するパラメータのリスト
テンプレートの中のデフォルト値は使用されます。
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 任意 テンプレートに渡す入力パラメータ
各キーと値のペアはパラメータとその引数です。
tags body string 任意 スタックに関連付けるタグ
コンマで区切られます。
template body object 任意 操作の対象となるスタックテンプレート
テンプレートの文字列です。
リクエストボディのJSON形式が正しくなるように、必要に応じてテンプレートに含まれる文字をエスケープして指定します。
例えば、ダブルクォーテーション(")を「\"」に、改行を「\n」に置換して指定します。
timeout_mins body integer 60
任意		 タイムアウト値(分単位)
converge body boolean 任意 「true」の場合は、スタックの現状を確認し、マージして更新します。

レスポンスボディ（正常系）の説明#

名前 Type Description
code string リソースを検索した場合のレスポンスコード
例： 302 Found.
message string リソースを検索した場合のメッセージ
title string リソースを検索した場合のレスポンスのタイトル
例： Found.

リクエスト例#

{
    "template": {
        "heat_template_version": "2013-05-23",
        "description": "Create a simple stack",
        "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"
                }
            }
        }
    },
    "parameters": {
        "flavor": "m1.small"
    }
}

レスポンス例#

{
    "code": "202 Accepted",
    "message": "The request is accepted for processing.<br /><br />\n\n\n",
    "title": "Accepted"
}