Show Resource Type 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

GET

/v1/{tenant_id}/resource_types/{type_name}/template

HTTPステータスコード

正常時：200

エラー時：400, 401, 404

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

名前	In	Type	デフォルト値 /必須指定	Description
tenant_id	path	string	必須	プロジェクトID
type_name	path	string	必須	リソースタイプ名
template_type	query	string	任意	リソーステンプレートタイプ 「cfn」または「hot」のどちらかです。

|

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

template_typeに「cfn」が指定された場合、または省略された場合のレスポンスパラメータ

名前	Type	Description
Description	string	テンプレートの説明
Ouptuts	string	出力データのキーと値のペア
HeatTemplateFormatVersion	string	オーケストレーション用のCFNテンプレートのバージョン
Parameters	object	CFN形式のパラメータスキーマ
Resources	object	リソーステンプレート内のリソース定義を含めるマップ

template_typeに「hot」が指定された場合のレスポンスパラメータ

名前	Type	Description
heat_template_version	string	オーケストレーション用のHOTテンプレートのバージョン
description	string	テンプレートの説明
outputs	object	出力データのキーと値のペア
parameters	object	HOT形式のパラメータスキーマ
resources	object	リソーステンプレート内のリソース定義を含めるマップ

レスポンス例

template_typeに「cfn」が指定されている場合

{
    "Description": "Initial template of KeyPair",
    "HeatTemplateFormatVersion": "2012-12-12",
    "Outputs": {
        "private_key": {
            "Description": "The private key if it has been saved.",
            "Value": "{\"Fn::GetAtt\": [\"KeyPair\", \"private_key\"]}"
        },
        "public_key": {
            "Description": "The public key.",
            "Value": "{\"Fn::GetAtt\": [\"KeyPair\", \"public_key\"]}"
        },
        "show": {
            "Description": "Detailed information about resource.",
            "Value": "{\"Fn::GetAtt\": [\"KeyPair\", \"show\"]}"
        }
    },
    "Parameters": {
        "name": {
            "Description": "The name of the key pair.",
            "MaxLength": 255,
            "MinLength": 1,
            "Type": "String"
        },
        "public_key": {
            "Description": "The optional public key. This allows users to supply the public key from a pre-existing key pair. If not supplied, a new key pair will be generated.",
            "Type": "String"
        },
        "save_private_key": {
            "AllowedValues": [
                "True",
                "true",
                "False",
                "false"
            ],
            "Default": false,
            "Description": "True if the system should remember a generated private key; False otherwise.",
            "Type": "Boolean"
        }
    },
    "Resources": {
        "KeyPair": {
            "Properties": {
                "name": {
                    "Ref": "name"
                },
                "public_key": {
                    "Ref": "public_key"
                },
                "save_private_key": {
                    "Ref": "save_private_key"
                }
            },
            "Type": "OS::Nova::KeyPair"
        }
    }
}

template_typeに「hot」が指定されている場合

{
    "description": "Initial template of KeyPair",
    "heat_template_version": "2016-10-14",
    "outputs": {
        "private_key": {
            "description": "The private key if it has been saved.",
            "value": "{\"get_attr\": [\"KeyPair\", \"private_key\"]}"
        },
        "public_key": {
            "description": "The public key.",
            "value": "{\"get_attr\": [\"KeyPair\", \"public_key\"]}"
        },
        "show": {
            "description": "Detailed information about resource.",
            "value": "{\"get_attr\": [\"KeyPair\", \"show\"]}"
        }
    },
    "parameters": {
        "name": {
            "constraints": [
                {
                    "length": {
                        "max": 255,
                        "min": 1
                    }
                }
            ],
            "description": "The name of the key pair.",
            "type": "string"
        },
        "public_key": {
            "description": "The optional public key. This allows users to supply the public key from a pre-existing key pair. If not supplied, a new key pair will be generated.",
            "type": "string"
        },
        "save_private_key": {
            "default": false,
            "description": "True if the system should remember a generated private key; False otherwise.",
            "type": "boolean"
        }
    },
    "resources": {
        "KeyPair": {
            "properties": {
                "name": {
                    "get_param": "name"
                },
                "public_key": {
                    "get_param": "public_key"
                },
                "save_private_key": {
                    "get_param": "save_private_key"
                }
            },
            "type": "OS::Nova::KeyPair"
        }
    }
}