Validate template

テンプレートを検証します。

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}/validate

HTTPステータスコード

正常時：200

エラー時：400, 500

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

名前	In	Type	デフォルト値 /必須指定	Description
tenant_id	path	string	必須	プロジェクトID
environment	body	object	任意	スタックの環境情報（JSON形式）
environment_files	body	object	任意	filesに含まれている環境ファイルの名前のリスト
files	body	object	任意	ファイル名とファイル内容のマップ テンプレートで組み込み関数 get_fileを使用する場合に指定します。 リクエストボディのJSON形式が正しくなるように、必要に応じてファイル内容に含まれる文字をエスケープして指定します。 例えば、ダブルクォーテーション(")を「\"」に、改行を「\n」に置換して指定します。
ignore_errors	query	string	任意	コンマで区切られる、無視するエラーコードのリスト
show_nested	query	boolean	任意	「true」の場合は、入れ子のスタックも返却されます。
template	body	object	任意※	操作の対象となるスタックテンプレート テンプレートの文字列です。 リクエストボディのJSON形式が正しくなるように、必要に応じてテンプレートに含まれる文字をエスケープして指定します。 例えば、ダブルクォーテーション(")を「\"」に、改行を「\n」に置換して指定します。 template_url パラメータと両方を指定した場合は、このパラメータが優先されます。 ※「template_url」または「template」のどちらかを指定してください。
template_url	body	string	任意※	テンプレートのURL パブリックにアクセスできる(全プロジェクトからアクセス可能)URLを指定します。 template パラメータを指定した場合は、このパラメータは無視されます。 ※「template_url」または「template」のどちらかを指定してください。

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

名前	Type	Description
Description	string	テンプレートの説明
ParameterGroups	array	パラメータグループのリスト 各グループにパラメータ名のリストが含まれています。
Parameters	object	CFN形式のパラメータスキーマ
Environment	object	スタックの環境 複数の環境ファイルが存在する場合は、マージされます。

リクエスト例

{
    "template_url": "/PATH_TO_HEAT_TEMPLATES/WordPress_Single_Instance.template"
}

レスポンス例

{
    "Description": "A template that provides a single server instance.",
    "Parameters": {
        "server-size": {
            "default": "1GB Standard Instance",
            "description": "Server size",
            "type": "String",
            "constraints": [
                {
                    "allowed_values": [
                        "512MB Standard Instance",
                        "1GB Standard Instance",
                        "4GB Standard Instance",
                        "8GB Standard Instance"
                    ],
                    "description": "Must be a valid server size."
                }
            ]
        },
        "key_name": {
            "description": "Keypair name for SSH access to the server",
            "required": true,
            "type": "String"
        },
        "server_name": {
            "default": "My server",
            "description": "My server",
            "type": "String"
        }
    },
    "ParameterGroups": [
        {
            "label": "Parameter groups",
            "description": "My parameter groups",
            "parameters": [
                "param_name-1",
                "param_name-2"
            ]
        }
    ],
    "Environment": {
        "event_sinks": [],
        "parameter_defaults": {},
        "parameters": {},
        "resource_registry": {
            "resources": {}
        }
    }
}