Show Resource Type Schema#

リソースタイプのインタフェーススキーマを表示します。

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}

HTTPステータスコード#

正常時:200

エラー時:400, 401, 404

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

名前 In Type デフォルト値
/必須指定
Description
tenant_id path string 必須 プロジェクトID
type_name path string 必須 リソースタイプ名

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

名前 Type Description
attributes object リソースの性質を表すキーと値のペア
properties object リソースの属性を表すキーと値のペア
resource_type string リソースタイプ名
support_status object リソースタイプのサポートステータス情報

レスポンス例#

{
    "attributes": {
        "an_attribute": {
            "description": "A runtime value of the resource."
        }
    },
    "properties": {
        "a_property": {
            "constraints": [
                {
                    "description": "Must be between 1 and 255 characters",
                    "length": {
                        "max": 255,
                        "min": 1
                    }
                }
            ],
            "description": "A resource description.",
            "required": true,
            "type": "string",
            "update_allowed": false
        }
    },
    "resource_type": "OS::Heat::AResourceName",
    "support_status": {
        "message": "A status message",
        "status": "SUPPORTED",
        "version": "2014.1"
    }
}