• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Heat
  5. Templates
  6. Show Resource Schema

Show Resource Schema

Function Description

This interface is used to query the attributes of the resource model.

Interface Format

Method

URI

Description

GET

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

Queries the attributes of the resource model.

Request Parameter

N/A

Response Parameter

Parameter

Type

Mandatory

Description

attributes

Dict

Yes

Specifies the resource feature dictionary.

description

String

Yes

Specifies the resource feature description.

properties

Dict

Yes

Specifies the resource attributes.

required

Boolean

Yes

Specifies whether the feature is required.

type

String

Yes

Specifies the attribute type.

update_allowed

Boolean

Yes

Updated or Not

resource_type

String

Yes

Specifies the resource type.

support_status

Dict

Yes

Specifies the current status information.

Request Example

N/A

Response Example

{
    "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"
    }
}

Returned Code

See section Return Code Processing.