List Resource Types

利用可能なテンプレートリソースタイプを一覧表示します。

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

HTTPステータスコード

正常時：200

エラー時：400, 401

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

名前	In	Type	デフォルト値 /必須指定	Description
tenant_id	path	string	必須	プロジェクトID
name	query	string	任意	レスポンスをリソースタイプ名で絞り込みます。正規表現と複数のリソースタイプ名を指定できます。
support_status	query	string	任意	レスポンスをサポートステータスで絞り込みます。有効な値は「UNKNOWN」、「SUPPORTED」、「DEPRECATED」、「UNSUPPORTED」と「HIDDEN」です。
with_description	query	boolean	任意	リソースタイプの説明の表示有無

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

名前	Type	Description
resource_types	array	リソースタイプのリスト with_descriptionが指定された場合は、各リソースタイプとその説明が表示されます。
resource_type	string	リソースタイプ名 with_descriptionが指定された場合に、本パラメータが表示されます。
description	string	リソースタイプの説明 with_descriptionが指定された場合に、本パラメータが表示されます。

レスポンス例

with_descriptionが指定されていない場合

{
    "resource_types": [
        "AWS::EC2::Instance",
        "OS::Heat::ScalingPolicy",
        "AWS::CloudFormation::Stack"
    ]
}

with_descriptionが指定されている場合

{
    "resource_types": [
        {
            "description": "No description given",
            "resource_type": "AWS::EC2::Instance"
        },
        {
            "description": "Resource for defining which resources can be accessed by users.\n\nNOTE: Now this resource is actually associated with an AWS user resource,\nnot any OS:: resource though it is registered under the OS namespace below.\n\nResource for defining resources that users are allowed to access by the\nDescribeStackResource API.\n",
            "resource_type": "OS::Heat::AccessPolicy"
        },
        {
            "description": "A resource to manage scaling of `OS::Heat::AutoScalingGroup`.\n\n**Note** while it may incidentally support\n`AWS::AutoScaling::AutoScalingGroup` for now, please do not use it for that\npurpose and use `AWS::AutoScaling::ScalingPolicy` instead.\n\nResource to manage scaling for `OS::Heat::AutoScalingGroup`, i.e. define\nwhich metric should be scaled and scaling adjustment, set cooldown etc.\n",
            "resource_type": "OS::Heat::ScalingPolicy"
        },
        {
            "description": "Represents a child stack to allow composition of templates.",
            "resource_type": "AWS::CloudFormation::Stack"
        },
        {
            "description": "Heat Template Resource for Keystone Group.\n\nGroups are a container representing a collection of users. A group itself\nmust be owned by a specific domain, and hence all group names are not\nglobally unique, but only unique to their domain.\n",
            "resource_type": "OS::Keystone::Group"
        }
    ]
}