List template functions#

テンプレート機能を一覧表示します。

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}/template_versions/{template_version}/functions

HTTPステータスコード#

正常時:200

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

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

名前 In Type デフォルト値
/必須指定
Description
tenant_id path string 必須 プロジェクトID
template_version path string 必須 テンプレートのバージョン

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

名前 Type Description
template_functions array 機能のオブジェクトのリスト
functions string 機能の名前
description string 機能の説明

レスポンス例#

{
    "template_functions": [
        {
            "functions": "Fn::Select",
            "description": "A function for selecting an item from a list or map."
        },
        {
            "functions": "repeat",
            "description": "A function for iterating over a list of items."
        },
        {
            "functions": "resource_facade",
            "description": "A function for retrieving data in a parent provider template."
        },
        {
            "functions": "list_join",
            "description": "A function for joining strings."
        },
        {
            "functions": "str_replace",
            "description": "A function for performing string substitutions."
        },
        {
            "functions": "get_attr",
            "description": "A function for resolving resource attributes."
        },
        {
            "functions": "get_param",
            "description": "A function for resolving parameter references."
        },
        {
            "functions": "get_file",
            "description": "A function for including a file inline."
        },
        {
            "functions": "digest",
            "description": "A function for performing digest operations."
        },
        {
            "functions": "get_resource",
            "description": "A function for resolving resource references."
        }
    ]
}