Common Parameters
+ +-
+
- Return Code
+
+
General Information
+ +Return Code
+Normal Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+The results of GET, PATCH, and PUT operations are returned normally. + |
+
201 + |
+Created + |
+The result of the POST operation is returned normally. + |
+
204 + |
+No Content + |
+The result of the DELETE operation is returned normally. + |
+
Error Return Code
+Return Code + |
+Type + |
+Possible Cause + |
+
|---|---|---|
400 + |
+Bad Request + |
+Incorrect request URI or body format. + |
+
Invalid request management status. + |
+||
Invalid value. + |
+||
The batch operation is not allowed. + |
+||
Authentication failed. + |
+||
Invalid request body, for example, the request attempt to update attributes that can be specified only during the creation. + |
+||
Missing required attributes. + |
+||
The specified attribute is not allowed, for example, an ID in a POST request in the basic CRUD operations. + |
+||
An unexpected data type attribute is specified. + |
+||
401 + |
+Unauthorized + |
+No identity authentication performed. + |
+
Invalid X-Auth-Token header. + |
+||
Invalid authentication credentials. + |
+||
403 + |
+Forbidden + |
+You have no permission to perform the requested operation. + |
+
404 + |
+Not Found + |
+The URI does not exist. + |
+
The requested resource was not found. + |
+||
Failed to complete the request because the reference entity could not be found by ID. The reference entity in POST requests may be specified in the request body instead of in the resource path. + |
+||
409 + |
+Conflict + |
+POST or PATCH operation failed. + |
+
500 + |
+Internal Server Error + |
+Internal OpenStack identity error. + |
+
503 + |
+Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
Redirection Description
+Redirect
In the Heat API, the stack ID consists of stack_name and stack_id. When the system calls APIs to access resources such as stacks, templates, events, and actions, if only stack_name is specified, Heat queries the stack_id value and returns a redirect response pointing to the correct URL. The following provides a request example:
+GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack+
After redirection, the actual request is as follows:
+Location: http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306+
Redirect APIs
The APIs used in the following topics support redirection. When calling the following APIs to access stacks or templates, you can specify only stack_name or stack_id.
+ +API Version Management
+ +Querying API Versions
+Function
This API is used to query all available versions.
+URI
GET /
+Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
versions + |
+body + |
+List <dict> + |
+Specifies the API version list. +Each object in the list provides API version information, such as the ID, status, and links. + |
+
versions structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
id + |
+body + |
+String + |
+Specifies the API version. + |
+
status + |
+body + |
+String + |
+Specifies the API version status. Available values are as follows: +
|
+
links + |
+body + |
+List <dict> + |
+Specifies the API URL list. +Each URL is a JSON object with one href keyword for identifying the URL and one rel keyword indicating the relationship between the API version and the involved stack. + |
+
Request Example
None
+Response Example
{
+ "versions": [
+ {
+ "status": "CURRENT",
+ "id": "v1.0",
+ "links": [
+ {
+ "href": "http://x.x.x.x:8774/v1/",
+ "rel": "self"
+ }
+ ]
+ }
+ ]
+}
+Return Code
The following code will be returned if the system is operating normally.
+ +Return Code + |
+Type + |
+Description + |
+
|---|---|---|
300 + |
+Multiple choices + |
+The requested resource has multiple available responses. + |
+
Stack Management
+ +-
+
- Querying the Stacks
+
+ - Creating a Stack
+
+ - Previewing a Stack
+
+ - Querying Details of a Stack
+
+ - Updating a Stack
+
+ - Deleting a Stack
+
+
Querying the Stacks
+Function
This API is used to query stacks of a specified tenant.
+Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
status/stack_status + |
+query + |
+String + |
+No + |
+Specifies the stack status. + |
+
name/stack_name + |
+query + |
+String + |
+No + |
+Specifies the stack name. +
|
+
limit + |
+query + |
+Integer + |
+No + |
+Specifies the number of returned stacks. This parameter is used to control the stack display mode and quantity. It can be used independently or together with the marker parameter. +For example, if the limit and marker parameters are not used, the queried stack list is as follows: +[stack1,stack2,stack3,stack4,stack5,stack6,stack7,stack8]+ If limit is set to 3, only the first three data records in the stack list are returned. +[stack1,stack2,stack3]+ If limit is set to 3 and marker is set to stack3, three stacks are displayed in sequence from the next data record of stack3. +[stack4,stack5,stack6]+ If limit is set to 3 and marker is set to stack6, but fewer than three data records are available after stack6, all the remaining data records are displayed. +[stack7,stack8]+ |
+
marker + |
+query + |
+String + |
+No + |
+Specifies the stack from which the next data record starts to be queried. This parameter is used to control the stack display mode and quantity. This parameter must be used together with the limit parameter. + |
+
sort_keys + |
+query + |
+String + |
+No + |
+Specifies the sorting keyword. +stack_name, stack_status, creation_time, and updated_time + |
+
sort_dir + |
+query + |
+String + |
+No + |
+Specifies the sorting method. +The value can be asc (in the ascending order) or desc (in the descending order). + |
+
Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
stacks + |
+body + |
+List <dict> + |
+Specifies the stack list. + |
+
stacks structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
id + |
+body + |
+String + |
+Specifies the stack UUID. + |
+
stack_name + |
+body + |
+String + |
+Specifies the stack name. + |
+
stack_status + |
+body + |
+String + |
+Specifies the stack status. + |
+
stack_status_reason + |
+body + |
+String + |
+Describes the stack operation. + |
+
description + |
+body + |
+String + |
+Describes the stack. + |
+
links + |
+body + |
+List <dict> + |
+Specifies the stack URL list. + |
+
creation_time + |
+body + |
+String + |
+Specifies the time when the stack was created. + |
+
updated_time + |
+body + |
+String + |
+Specifies the time when the stack was updated. + |
+
parent + |
+body + |
+String + |
+Specifies the UUID of the parent stack (for a nested stack). + |
+
tags + |
+body + |
+String + |
+Specifies the stack tag. + |
+
stack_user_project_id + |
+body + |
+String + |
+Specifies the project UUID of the stack user. This parameter may be left blank. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks+
Response Example
{
+ "stacks": [
+ {
+ "description": "Hello world HOT template that just defines a single compute instance. Contains just base features to verify base HOT support.\n",
+ "links": [
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306",
+ "rel": "self"
+ }
+ ],
+ "stack_status_reason": "Stack create completed successfully",
+ "stack_name": "HeatStack",
+ "creation_time": "2018-01-26T17:21:35Z",
+ "updated_time": "2018-01-26T17:21:41Z",
+ "stack_status": "CREATE_COMPLETE",
+ "id": "c89c4bb3-96cb-4a55-aafa-076a7939a306"
+ }
+ ]
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Creating a Stack
+Function
This API is used to create a stack. Heat verifies a request body and parses the template. After that, Heat invokes the API of the target component based on resource dependencies to create a resource.
+Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
stack_name + |
+body + |
+String + |
+Yes + |
+Specifies the stack name. +
|
+
template + |
+body + |
+Json + |
+Yes + |
+Specifies the template. The template uses the YAML syntax for content orchestration. + |
+
template_url + |
+body + |
+String + |
+No + |
+Specifies the template URL. You cannot select a template using the URL temporarily. + |
+
environment + |
+body + |
+Json + |
+No + |
+Specifies the environment information for creating a stack. + |
+
files + |
+body + |
+Json + |
+No + |
+Specifies the files referenced in the environment. + |
+
parameters + |
+body + |
+Json + |
+No + |
+Specifies parameter information of the stack. + |
+
timeout_mins + |
+body + |
+Int + |
+No + |
+Specifies the timeout duration. + |
+
disable_rollback + |
+body + |
+Boolean + |
+No + |
+Specifies whether to perform a rollback when stack creation fails. + |
+
environment structure information
+ +Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
parameters + |
+body + |
+Json + |
+No + |
+Specifies the parameters and their values. + |
+
parameters_defaults + |
+body + |
+Json + |
+No + |
+Specifies the parameters and their default values. + |
+
resource_registry + |
+body + |
+Json + |
+No + |
+Specifies the custom resource information. + |
+
Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
stack + |
+body + |
+Dict + |
+Specifies the stack object. + |
+
stack structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
id + |
+body + |
+String + |
+Specifies the stack UUID. + |
+
links + |
+body + |
+List <dict> + |
+Specifies the stack URL list. + |
+
Request Example
POST /v1/95d02433133a4c0a87ba6967474a2ad3/stacks
+{
+ "files": {},
+ "disable_rollback": true,
+ "parameters": {
+ "flavor": "m1.heat"
+ },
+ "environment": {
+ "parameters": {
+ "flavor": "m1.heat"
+ },
+ "parameter_defaults": {
+ "flavor": "m1.heat"
+ },
+ "resource_registry": {
+ "OS::Networking::FloatingIP": "OS::Nova::FloatingIP"
+ }
+ },
+ "stack_name": "teststack",
+ "template": {
+ "heat_template_version": "2013-05-23",
+ "description": "Simple template to test heat commands",
+ "parameters": {
+ "flavor": {
+ "default": "m1.tiny",
+ "type": "string"
+ }
+ },
+ "resources": {
+ "hello_world": {
+ "type": "OS::Nova::Server",
+ "properties": {
+ "key_name": "heat_key",
+ "flavor": {
+ "get_param": "flavor"
+ },
+ "image": "40be8d1a-3eb9-40de-8abd-43237517384f",
+ "user_data": "#!/bin/bash -xv\necho \"hello world\" > /root/hello-world.txt\n"
+ }
+ }
+ }
+ },
+ "timeout_mins": 60
+}
+Response Example
{
+ "stack": {
+ "id": "c89c4bb3-96cb-4a55-aafa-076a7939a306",
+ "links": [
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306",
+ "rel": "self"
+ }
+ ]
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
201 + |
+Created + |
+The resource has been created and is ready for use. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
409 + |
+Conflict + |
+The request could not be processed due to a conflict. + |
+
Previewing a Stack
+Function
This API is used to preview a stack.
+Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
stack_name + |
+body + |
+String + |
+Yes + |
+Specifies the stack name. +
|
+
template_url + |
+body + |
+String + |
+No + |
+Specifies the template URL. You cannot select a template using the URL temporarily. + |
+
template + |
+body + |
+Dict + |
+Yes + |
+Specifies the template. The template content must use the YAML syntax. + |
+
files + |
+body + |
+Dict + |
+No + |
+Specifies the files referenced in the environment. + |
+
disable_rollback + |
+body + |
+Boolean + |
+No + |
+Specifies whether to perform a rollback when stack creation fails. + |
+
parameters + |
+body + |
+Dict + |
+No + |
+Specifies parameter information of the stack. + |
+
Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
stack + |
+body + |
+Dict + |
+Specifies the stack object. + |
+
stack structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
parent + |
+body + |
+String + |
+Specifies the UUID of the parent stack (for a nested stack). + |
+
id + |
+body + |
+String + |
+Specifies the stack UUID. + |
+
links + |
+body + |
+List <dict> + |
+Specifies the stack URL list. + |
+
stack_name + |
+body + |
+String + |
+Specifies the stack name. + |
+
description + |
+body + |
+String + |
+Describes the stack. + |
+
template_description + |
+body + |
+String + |
+Describes the template defined by the stack. + |
+
timeout_mins + |
+body + |
+Int + |
+Specifies the timeout duration. + |
+
disable_rollback + |
+body + |
+Boolean + |
+Specifies whether to perform a rollback when stack creation fails. + |
+
capabilities + |
+body + |
+List + |
+Specifies the list of stack capacities. + |
+
creation_time + |
+body + |
+Date Time + |
+Specifies the time when the stack was created. + |
+
notification_topics + |
+body + |
+List + |
+Specifies the message notification list of the stack. + |
+
updated_time + |
+body + |
+Date Time + |
+Specifies the last time when the stack was updated. + |
+
stack_owner + |
+body + |
+Sting + |
+Specifies the name of the stack owner. + |
+
parameters + |
+body + |
+Dict + |
+Specifies parameters defined by the stack. + |
+
resources + |
+body + |
+List <dict> + |
+Specifies the stack resource list. + |
+
Request Example
POST /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/preview
+{
+ "files": {},
+ "disable_rollback": true,
+ "parameters": {
+ "flavor": "m1.heat"
+ },
+ "stack_name": "teststack",
+ "template": {
+ "heat_template_version": "2013-05-23",
+ "description": "Simple template to test heat commands",
+ "parameters": {
+ "flavor": {
+ "default": "m1.tiny",
+ "type": "string"
+ }
+ },
+ "resources": {
+ "hello_world": {
+ "type": "OS::Nova::Server",
+ "properties": {
+ "key_name": "heat_key",
+ "flavor": {
+ "get_param": "flavor"
+ },
+ "image": "40be8d1a-3eb9-40de-8abd-43237517384f",
+ "user_data": "#!/bin/bash -xv\necho \"hello world\" > /root/hello-world.txt\n"
+ }
+ }
+ }
+ },
+ "timeout_mins": 60
+}
+Response Example
{
+ "stack": {
+ "capabilities": [],
+ "creation_time": "2015-01-31T15:12:36Z",
+ "description": "HOT template for Nova Server resource.\n",
+ "disable_rollback": true,
+ "id": "None",
+ "links": [
+ {
+ "href": "http://x.x.x.x:8004/v1/6e18cc2bdbeb48a5basad2dc499f6804/stacks/test_stack/None",
+ "rel": "self"
+ }
+ ],
+ "notification_topics": [],
+ "parameters": {
+ "OS::project_id": "6e18cc2bdbeb48a5basad2dc499f6804",
+ "OS::stack_id": "None",
+ "OS::stack_name": "teststack",
+ "admin_user": "cloud-user",
+ "flavor": "m1.small",
+ "image": "F20-cfg",
+ "key_name": "heat_key",
+ "server_name": "MyServer"
+ },
+ "parent": null,
+ "resources": [
+ {
+ "attributes": {},
+ "description": "",
+ "metadata": {},
+ "physical_resource_id": "",
+ "properties": {
+ "description": "Ping and SSH",
+ "name": "the_sg",
+ "rules": [
+ {
+ "direction": "ingress",
+ "ethertype": "IPv4",
+ "port_range_max": null,
+ "port_range_min": null,
+ "protocol": "icmp",
+ "remote_group_id": null,
+ "remote_ip_prefix": null,
+ "remote_mode": "remote_ip_prefix"
+ },
+ {
+ "direction": "ingress",
+ "ethertype": "IPv4",
+ "port_range_max": 65535,
+ "port_range_min": 1,
+ "protocol": "tcp",
+ "remote_group_id": null,
+ "remote_ip_prefix": null,
+ "remote_mode": "remote_ip_prefix"
+ },
+ {
+ "direction": "ingress",
+ "ethertype": "IPv4",
+ "port_range_max": 65535,
+ "port_range_min": 1,
+ "protocol": "udp",
+ "remote_group_id": null,
+ "remote_ip_prefix": null,
+ "remote_mode": "remote_ip_prefix"
+ }
+ ]
+ },
+ "required_by": [
+ "server1"
+ ],
+ "resource_action": "INIT",
+ "resource_identity": {
+ "path": "/resources/the_sg_res",
+ "stack_id": "None",
+ "stack_name": "teststack",
+ "tenant": "6e18cc2bdbeb48a5b3cad2dc499f6804"
+ },
+ "resource_name": "the_sg_res",
+ "resource_status": "COMPLETE",
+ "resource_status_reason": "",
+ "resource_type": "OS::Neutron::SecurityGroup",
+ "stack_identity": {
+ "path": "",
+ "stack_id": "None",
+ "stack_name": "teststack",
+ "tenant": "6e18cc2bdbeb48a5b3cad2dc499f6804"
+ },
+ "stack_name": "teststack",
+ "updated_time": "2015-01-31T15:12:36Z"
+ },
+ {
+ "attributes": {
+ "accessIPv4": "",
+ "accessIPv6": "",
+ "addresses": "",
+ "console_urls": "",
+ "first_address": "",
+ "instance_name": "",
+ "name": "MyServer",
+ "networks": "",
+ "show": ""
+ },
+ "description": "",
+ "metadata": {},
+ "physical_resource_id": "",
+ "properties": {
+ "admin_pass": null,
+ "admin_user": "cloud-user",
+ "availability_zone": null,
+ "block_device_mapping": null,
+ "config_drive": null,
+ "diskConfig": null,
+ "flavor": "m1.small",
+ "flavor_update_policy": "RESIZE",
+ "image": "F20-cfg",
+ "image_update_policy": "REPLACE",
+ "key_name": "heat_key",
+ "metadata": {
+ "ha_stack": "None"
+ },
+ "name": "MyServer",
+ "networks": [
+ {
+ "fixed_ip": null,
+ "network": "private",
+ "port": null,
+ "uuid": null
+ }
+ ],
+ "personality": {},
+ "reservation_id": null,
+ "scheduler_hints": null,
+ "security_groups": [
+ "None"
+ ],
+ "software_config_transport": "POLL_SERVER_CFN",
+ "user_data": "",
+ "user_data_format": "HEAT_CFNTOOLS"
+ },
+ "required_by": [],
+ "resource_action": "INIT",
+ "resource_identity": {
+ "path": "/resources/hello_world",
+ "stack_id": "None",
+ "stack_name": "teststack",
+ "tenant": "6e18cc2bdbeb48a3433cad2dc499sdf32234"
+ },
+ "resource_name": "hello_world",
+ "resource_status": "COMPLETE",
+ "resource_status_reason": "",
+ "resource_type": "OS::Nova::Server",
+ "stack_identity": {
+ "path": "",
+ "stack_id": "None",
+ "stack_name": "teststack",
+ "tenant": "6e18cc2bdbeb48a3433cad2dc499sdf32234"
+ },
+ "stack_name": "teststack",
+ "updated_time": "2015-01-31T15:12:36Z"
+ }
+ ],
+ "stack_name": "test_stack",
+ "stack_owner": "admin",
+ "template_description": "HOT template for Nova Server resource.\n",
+ "timeout_mins": null,
+ "updated_time": null
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
201 + |
+Created + |
+The resource has been created and is ready for use. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
409 + |
+Conflict + |
+The request could not be processed due to a conflict. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Querying Details of a Stack
+Function
This API is used to query details of a stack.
+URI
GET /v1/{project_id}/stacks/{stack_name}/{stack_id}
+
This API supports redirection. During the calling, you can specify only stack_name or stack_id.
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
stack + |
+body + |
+Dict + |
+Specifies the stack object. + |
+
stack structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
disable_rollback + |
+body + |
+Boolean + |
+Specifies whether to perform a rollback when stack creation fails. + |
+
description + |
+body + |
+String + |
+Describes the stack. + |
+
parent + |
+body + |
+String + |
+Specifies the ID of the parent stack if the stack is the nesting type. + |
+
tags + |
+body + |
+Array + |
+Specifies whether to perform a rollback when stack creation fails. + |
+
parameters + |
+body + |
+Dict + |
+Specifies parameter information of the stack. + |
+
stack_status_reason + |
+body + |
+String + |
+Describes the stack operation. + |
+
stack_name + |
+body + |
+String + |
+Specifies the stack name. + |
+
stack_user_project_id + |
+body + |
+String + |
+This is a reserved parameter. + |
+
outputs + |
+body + |
+List + |
+Specifies the output stack list. + |
+
creation_time + |
+body + |
+String + |
+Specifies the time when the stack was created. + |
+
links + |
+body + |
+List <dict> + |
+Specifies the stack URL list. + |
+
capabilities + |
+body + |
+List + |
+Specifies the list of stack capacities. + |
+
notification_topics + |
+body + |
+List + |
+Specifies the message notification list of the stack. + |
+
timeout_mins + |
+body + |
+Integer + |
+Specifies the timeout duration. + |
+
stack_status + |
+body + |
+String + |
+Specifies the stack status. + |
+
stack_owner + |
+body + |
+String + |
+This is a reserved parameter. + |
+
updated_time + |
+body + |
+String + |
+Specifies the time when the stack was updated. + |
+
id + |
+body + |
+String + |
+Specifies the stack UUID. + |
+
template_description + |
+body + |
+String + |
+Describes the template. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306+
Response Example
{
+ "stack": {
+ "disable_rollback": true,
+ "description": "Hello world HOT template that just defines a single compute instance. Contains just base features to verify base HOT support.\n",
+ "parent": null,
+ "tags": null,
+ "parameters": {
+ "Network": "3f8713b7-8aea-4b0f-a70b-98d4e1d6251f",
+ "OS::stack_name": "HeatStack",
+ "ImageId": "68e22196-a4aa-4946-85c3-75f4957e667a",
+ "OS::stack_id": "c89c4bb3-96cb-4a55-aafa-076a7939a306",
+ "KeyName": "heat-key",
+ "OS::project_id": "95d02433133a4c0a87ba6967474a2ad3",
+ "InstanceType": "m1.tiny"
+ },
+ "stack_user_project_id": "95d02433133a4c0a87ba6967474a2ad3",
+ "stack_status_reason": "Stack create completed successfully",
+ "stack_name": "HeatStack",
+ "outputs": [],
+ "creation_time": "2014-01-26T17:21:35Z",
+ "links": [
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306",
+ "rel": "self"
+ }
+ ],
+ "capabilities": [],
+ "notification_topics": [],
+ "timeout_mins": 60,
+ "stack_status": "CREATE_COMPLETE",
+ "stack_owner": null,
+ "updated_time": "2014-01-26T17:21:41Z",
+ "id": "c89c4bb3-96cb-4a55-aafa-076a7939a306",
+ "template_description": "Hello world HOT template that just defines a single compute instance. Contains just base features to verify base HOT support.\n"
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
302 + |
+Found + |
+The response is about redirection. The response header usually contains a location value that allows you to track the real location of the resource. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Updating a Stack
+Function
This API is used to update a stack.
+URI
PUT /v1/{project_id}/stacks/{stack_name}/{stack_id}
+For details about the parameters, see Table 1.
+ + +Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
template + |
+body + |
+Json + |
+Yes + |
+Specifies the template. The template content must use the YAML syntax. + |
+
template_url + |
+body + |
+String + |
+No + |
+Specifies the template URL. You cannot select a template using the URL temporarily. + |
+
environment + |
+body + |
+Json + |
+No + |
+Specifies information about the environment for creating a stack. + |
+
files + |
+body + |
+Json + |
+No + |
+Specifies the files referenced in the environment. + |
+
parameters + |
+body + |
+Json + |
+No + |
+Specifies parameter information of the stack. + |
+
timeout_mins + |
+body + |
+Int + |
+No + |
+Specifies the timeout duration. + |
+
disable_rollback + |
+body + |
+Boolean + |
+No + |
+Specifies whether to perform a rollback when a stack update fails. + |
+
Response Parameter
N/A
+Request Example
PUT /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306
+{
+ "template": {
+ "heat_template_version": "2013-05-23",
+ "description": "Create a simple stack",
+ "parameters": {
+ "flavor": {
+ "default": "m1.tiny",
+ "type": "string"
+ }
+ },
+ "resources": {
+ "hello_world": {
+ "type": "OS::Nova::Server",
+ "properties": {
+ "key_name": "heat_key",
+ "flavor": {
+ "get_param": "flavor"
+ },
+ "image": "40be8d1a-3eb9-40de-8abd-43237517384f",
+ "user_data": "#!/bin/bash -xv\necho \"hello world\" > /root/hello-world.txt\n"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "flavor": "m1.small"
+ }
+}
+Response Example
None
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
202 + |
+Accepted + |
+The request has been accepted, but the processing is not complete. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Deleting a Stack
+Function
This API is used to delete a stack.
+URI
DELETE /v1/{project_id}/stacks/{stack_name}/{stack_id}
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
This request does not return any content in the response body.
+Request Example
DELETE /v1/9c53a566cb3443ab910cf0daebca90c4/stacks/HeatStack/34247a47-7bf9-4842-a899-421a3cca5779+
Response Example
None
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
204 + |
+No Content + |
+The RTS service has fulfilled the request by deleting the resource. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Stack Resource Management
+ +-
+
- Querying Resources of a Stack
+
+ - Querying Details of a Stack Resource
+
+ - Querying Metadata of a Stack Resource
+
+ - Sending a Signal to a Stack Resource
+
+ - Marking a Resource as Unhealthy
+
+
Querying Resources of a Stack
+Function
This API is used to query resources of a stack.
+URI
GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources
+ This API supports redirection. During the calling, you can specify only stack_name or stack_id.
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
resources + |
+body + |
+List <dict> + |
+Specifies resource information of the stack. + |
+
resources structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
resource_name + |
+body + |
+String + |
+Specifies the resource name. + |
+
links + |
+body + |
+List <dict> + |
+Specifies the resource URL list. + |
+
logical_resource_id + |
+body + |
+String + |
+Specifies the logical resource ID. + |
+
physical_resource_id + |
+body + |
+String + |
+Specifies the physical resource ID. + |
+
resource_type + |
+body + |
+String + |
+Specifies the resource type. + |
+
resource_status + |
+body + |
+String + |
+Specifies the resource status. + |
+
resource_status_reason + |
+body + |
+String + |
+Specifies the resource operation reason. + |
+
updated_time + |
+body + |
+String + |
+Specifies the time when the resource was updated. + |
+
creation_time + |
+body + |
+String + |
+Specifies the time when the resource was created. + |
+
required_by + |
+body + |
+List <str> + |
+Specifies the resource dependency. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources+
Response Example
{
+ "resources": [
+ {
+ "resource_name": "instacne_port",
+ "links": [
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/instacne_port",
+ "rel": "self"
+ },
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306",
+ "rel": "stack"
+ }
+ ],
+ "logical_resource_id": "instacne_port",
+ "resource_status_reason": "state changed",
+ "updated_time": "2014-01-27T16:28:03Z",
+ "required_by": ["my_instance"],
+ "resource_status": "RESUME_COMPLETE",
+ "physical_resource_id": "202307c7-d10e-4bcf-af85-6253f5d6b022",
+ "resource_type": "OS::Neutron::Port"
+ },
+ {
+ "resource_name": "my_instance",
+ "links": [
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/my_instance",
+ "rel": "self"
+ },
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306",
+ "rel": "stack"
+ }
+ ],
+ "logical_resource_id": "my_instance",
+ "resource_status_reason": "state changed",
+ "updated_time": "2014-01-27T16:28:06Z",
+ "required_by": [],
+ "resource_status": "RESUME_COMPLETE",
+ "physical_resource_id": "e722ad16-ff09-4622-aa5c-0466ae4ef8d8",
+ "resource_type": "OS::Nova::Server"
+ }
+ ]
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
302 + |
+Found + |
+The response is about redirection. The response header usually contains a location value that allows you to track the real location of the resource. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Querying Details of a Stack Resource
+Function
This API is used to query details of a stack resource.
+URI
GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}
+For details about the parameters, see Table 1.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. + |
+
stack_name + |
+String + |
+Yes + |
+Specifies the stack name. + |
+
stack_id + |
+String + |
+Yes + |
+Specifies the stack UUID. + |
+
resource_name + |
+String + |
+Yes + |
+Specifies the name of the resource in the stack. + |
+
Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
resource + |
+body + |
+Dict + |
+Specifies resource information of the stack. + |
+
resource structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
resource_name + |
+body + |
+String + |
+Specifies the resource name. + |
+
description + |
+body + |
+String + |
+Describes the resource. + |
+
links + |
+body + |
+List <dict> + |
+Specifies the resource URL list. + |
+
logical_resource_id + |
+body + |
+String + |
+Specifies the logical resource ID. + |
+
creation_time + |
+body + |
+String + |
+Specifies the time of creating the stack resource. +Example: 2019-04-30T02:55:48.869333 + |
+
physical_resource_id + |
+body + |
+String + |
+Specifies the physical resource ID. + |
+
attributes + |
+body + |
+Object + |
+Includes key-value pairs of the resource attribute. + |
+
resource_type + |
+body + |
+String + |
+Specifies the resource type. + |
+
resource_status + |
+body + |
+String + |
+Specifies the resource status. + |
+
resource_status_reason + |
+body + |
+String + |
+Specifies the resource operation reason. + |
+
updated_time + |
+body + |
+String + |
+Specifies the time when the resource was updated. + |
+
required_by + |
+body + |
+List <str> + |
+Specifies the resource dependency. + |
+
Request Example
GET /v1/6e0193034db54600b889f890768a72ea/stacks/stack-0vi3/63a16fbe-717b-417c-a3e5-08fc51544b49/resources/random-group+
Response Example
{
+ "resource": {
+ "attributes": {
+ "attributes": null,
+ "refs": null
+ },
+ "creation_time": "2019-03-04T06:36:45.455761",
+ "description": "",
+ "links": [
+ {
+ "href": "https://orchestration.localdomain.com:8004/v1/6e0193034db54600b889f890768a72ea/stacks/stack-0vi3/63a16fbe-717b-417c-a3e5-08fc51544b49/resources/random-group",
+ "rel": "self"
+ },
+ {
+ "href": "https://orchestration.localdomain.com:8004/v1/6e0193034db54600b889f890768a72ea/stacks/stack-0vi3/63a16fbe-717b-417c-a3e5-08fc51544b49",
+ "rel": "stack"
+ },
+ {
+ "href": "https://orchestration.localdomain.com:8004/v1/6e0193034db54600b889f890768a72ea/stacks/stack-0vi3-random-group-k7emexipm2k6/2b6d0d58-0a7b-45d7-978f-519d0b1395ce",
+ "rel": "nested"
+ }
+ ],
+ "logical_resource_id": "random-group",
+ "physical_resource_id": "2b6d0d58-0a7b-45d7-978f-519d0b1395ce",
+ "required_by": [],
+ "resource_name": "random-group",
+ "resource_status": "CREATE_COMPLETE",
+ "resource_status_reason": "state changed",
+ "resource_type": "OS::Heat::ResourceGroup",
+ "updated_time": "2019-03-04T06:36:45.455761"
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Querying Metadata of a Stack Resource
+Function
This API is used to query metadata of a stack resource.
+URI
GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/metadata
+For details about the parameters, see Table 1.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. + |
+
stack_name + |
+String + |
+Yes + |
+Specifies the stack name. + |
+
stack_id + |
+String + |
+Yes + |
+Specifies the stack UUID. + |
+
resource_name + |
+String + |
+Yes + |
+Specifies the name of the resource in the stack. + |
+
Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
metadata + |
+body + |
+Dict + |
+Specifies the resource metadata. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/my_instance/metadata+
Response Example
{
+ "metadata": {
+ "Name": "SmokeServer"
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Sending a Signal to a Stack Resource
+Function
This API is used to send a signal to a stack resource to change the resource orchestration.
+URI
POST /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/signal
+For details about the parameters, see Table 1.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. + |
+
stack_name + |
+String + |
+Yes + |
+Specifies the stack name. + |
+
stack_id + |
+String + |
+Yes + |
+Specifies the stack UUID. + |
+
resource_name + |
+String + |
+Yes + |
+Specifies the name of the resource in the stack. + |
+
Request Parameter
The requested content is determined by the stack resource to which the signal is to be sent. Some resources cannot receive signals.
+ This API is asynchronous. Status code 200 is returned if the request is successfully received.
+Response Parameter
This operation does not return the response body.
+Request Example
POST /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/65eb0ae7-36de-4104-aace-6bd040a2f95f/resources/my_instance/signal+
Response Example
None
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Marking a Resource as Unhealthy
+Function
This API is used to mark the status of a specified resource as unhealthy.
+URI
PATCH /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name_or_physical_id}
+For details about the parameters, see Table 1.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. + |
+
stack_name + |
+String + |
+Yes + |
+Specifies the stack name. + |
+
stack_id + |
+String + |
+Yes + |
+Specifies the stack UUID. + |
+
resource_name_or_physical_id + |
+String + |
+Yes + |
+Specifies the resource name. + |
+
Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
mark_unhealthy + |
+body + |
+Boolean + |
+Yes + |
+Specifies whether to mark the status of a resource as unhealthy. + |
+
resource_status_reason + |
+body + |
+String + |
+No + |
+Describes the cause causing the current resource status. + |
+
Response Parameter
This operation does not return the response body.
+Request Example
PATCH /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/65eb0ae7-36de-4104-aace-6bd040a2f95f/resources/my_instance
+{
+ "mark_unhealthy": false,
+ "resource_status_reason": "test reset"
+}
+Response Example
None
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Stack Action Management
+ +Canceling Stack Updates
+Function
This API is used to cancel updating a stack.
+URI
POST /v1/{project_id}/stacks/{stack_name}/{stack_id}/actions
+For details about the parameters, see Table 1.
+ + +Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
cancel_update + |
+body + |
+Object + |
+Yes + |
+Cancels updating a stack. + |
+
Response Parameter
This operation does not return the response body.
+Request Example
POST /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/actions
+{
+ "cancel_update": null
+}
+Response Example
None
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Checking a Stack
+Function
This API is used to check whether a stack is in the expected status.
+URI
POST /v1/{project_id}/stacks/{stack_name}/{stack_id}/actions
+For details about the parameters, see Table 1.
+ + +Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
check + |
+body + |
+Object + |
+Yes + |
+Checks stack resources. + |
+
Response Parameter
This operation does not return the response body.
+Request Example
POST /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/actions
+{
+ "check": null
+}
+Response Example
None
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Stack Event Management
+ +-
+
- Querying Events of a Stack
+
+ - Querying Events of a Stack Resource
+
+ - Querying Details of a Stack Resource Event
+
+
Querying Events of a Stack
+Function
This API is used to query events of a stack.
+URI
GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/events
+ This API supports redirection. During the calling, you can specify only stack_name or stack_id.
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
events + |
+body + |
+List <dict> + |
+Specifies the events of a resource. + |
+
events structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
resource_name + |
+body + |
+String + |
+Specifies the resource name. + |
+
event_time + |
+body + |
+String + |
+Specifies the time when an event occurs. + |
+
links + |
+body + |
+List <dict> + |
+Specifies the event URL list. + |
+
logical_resource_id + |
+body + |
+String + |
+Specifies the logical resource ID. + |
+
resource_status_reason + |
+body + |
+String + |
+Specifies the resource operation reason. + |
+
resource_status + |
+body + |
+String + |
+Specifies the resource status. + |
+
physical_resource_id + |
+body + |
+String + |
+Specifies the physical resource ID. + |
+
id + |
+body + |
+String + |
+Specifies the event ID. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/events+
Response Example
{
+ "events": [
+ {
+ "resource_name": "instacne_port",
+ "event_time": "2014-01-26T17:21:35Z",
+ "links": [
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/instacne_port/events/1302",
+ "rel": "self"
+ },
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/instacne_port",
+ "rel": "resource"
+ },
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306",
+ "rel": "stack"
+ }
+ ],
+ "logical_resource_id": "instacne_port",
+ "resource_status_reason": "state changed",
+ "resource_status": "CREATE_IN_PROGRESS",
+ "physical_resource_id": null,
+ "id": "1302"
+ }
+ ]
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
302 + |
+Found + |
+The response is about redirection. The response header usually contains a location value that allows you to track the real location of the resource. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Querying Events of a Stack Resource
+Function
This API is used to query events of a stack resource.
+URI
GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/events
+For details about the parameters, see Table 1.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. + |
+
stack_name + |
+String + |
+Yes + |
+Specifies the stack name. + |
+
stack_id + |
+String + |
+Yes + |
+Specifies the stack UUID. + |
+
resource_name + |
+String + |
+Yes + |
+Specifies the name of the resource in the stack. + |
+
Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
events + |
+body + |
+List <dict> + |
+Specifies the events of a resource. + |
+
events structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
resource_name + |
+body + |
+String + |
+Specifies the resource name. + |
+
event_time + |
+body + |
+String + |
+Specifies the time when an event occurs. + |
+
links + |
+body + |
+List <dict> + |
+Specifies the event URL list. + |
+
logical_resource_id + |
+body + |
+String + |
+Specifies the logical resource ID. + |
+
resource_status_reason + |
+body + |
+String + |
+Specifies the resource operation reason. + |
+
resource_status + |
+body + |
+String + |
+Specifies the resource status. + |
+
physical_resource_id + |
+body + |
+String + |
+Specifies the physical resource ID. + |
+
id + |
+body + |
+String + |
+Specifies the event ID. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/my_instance/events+
Response Example
{
+ "events": [
+ {
+ "resource_name": "my_instance",
+ "event_time": "2014-01-26T17:21:35Z",
+ "links": [
+ {
+ "href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/my_instance/events/1304",
+ "rel": "self"
+ }
+ ],
+ "logical_resource_id": "instacne_port",
+ "resource_status_reason": "state changed",
+ "resource_status": "CREATE_IN_PROGRESS",
+ "physical_resource_id": null,
+ "id": "1302"
+ }
+ ]
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Querying Details of a Stack Resource Event
+Function
This API is used to query details of a stack resource event.
+URI
GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/events/{event_id}
+For details about the parameters, see Table 1.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. + |
+
stack_name + |
+String + |
+Yes + |
+Specifies the stack name. + |
+
stack_id + |
+String + |
+Yes + |
+Specifies the stack UUID. + |
+
resource_name + |
+String + |
+Yes + |
+Specifies the name of the resource in the stack. + |
+
event_id + |
+String + |
+Yes + |
+Specifies the UUID of the event related to the resource in the stack. + |
+
Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
event + |
+body + |
+Dict + |
+Specifies a resource event. + |
+
event structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
event_time + |
+body + |
+String + |
+Specifies the time when an event occurs. + |
+
id + |
+body + |
+String + |
+Specifies the UUID of the event object. + |
+
links + |
+body + |
+List <dict> + |
+Specifies the event URL list. Each URL is a JSON object with one href keyword for identifying the URL and one rel keyword indicating the event relationship. Multiple URLs may be returned. + |
+
logical_resource_id + |
+body + |
+String + |
+Specifies the logical stack resource ID. + |
+
physical_resource_id + |
+body + |
+String + |
+Specifies the physical stack resource ID. + |
+
resource_name + |
+body + |
+String + |
+Specifies the resource name. + |
+
resource_properties + |
+body + |
+Dict + |
+Specifies the mapping between resource attributes and events. + |
+
resource_status + |
+body + |
+String + |
+Specifies the resource status. + |
+
resource_status_reason + |
+body + |
+String + |
+Specifies the cause causing the current stack resource status. + |
+
resource_type + |
+body + |
+String + |
+Specifies the resource type name. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/random_str/events/1313+
Response Example
{
+ "event": {
+ "event_time": "2014-02-18T18:23:27Z",
+ "id": "485",
+ "links": [
+ {
+ "href": "http://x.x.x.x:8004/v1/8443bcd779f3435e86e1cbf73d98a89c/stacks/heat168714801/e6d10493-8d85-46cb-bf3c-e5572f255ef5/resources/random_str/events/1313",
+ "rel": "self"
+ },
+ {
+ "href": "http://x.x.x.x:8004/v1/8443bcd779f3435e86e1cbf73d98a89c/stacks/heat168714801/e6d10493-8d85-46cb-bf3c-e5572f255ef5/resources/random_str",
+ "rel": "resource"
+ },
+ {
+ "href": "http://x.x.x.x:8004/v1/8443bcd779f3435e86e1cbf73d98a89c/stacks/heat168714801/e6d10493-8d85-46cb-bf3c-e5572f255ef5",
+ "rel": "stack"
+ }
+ ],
+ "logical_resource_id": "random_key_name",
+ "physical_resource_id": null,
+ "resource_name": "random_key_name",
+ "resource_properties": {
+ "character_classes": null,
+ "character_sequences": null,
+ "length": 8,
+ "salt": null,
+ "sequence": null
+ },
+ "resource_status": "CREATE_IN_PROGRESS",
+ "resource_status_reason": "state changed",
+ "resource_type": "OS::Heat::RandomString"
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Template Management
+ +Querying a Stack Template
+Function
This API is used to query a stack template.
+URI
GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/template
+ This API supports redirection. During the calling, you can specify only stack_name or stack_id.
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
heat_template_version + |
+body + |
+String + |
+Specifies the version of the HOT template. + |
+
outputs + |
+body + |
+Dict + |
+Includes key-value pairs of the output data. + |
+
parameters + |
+body + |
+Dict + |
+Specifies the key-value pairs of template parameters. + |
+
description + |
+body + |
+String + |
+Describes the stack template. + |
+
resources + |
+body + |
+Dict + |
+Specifies the template resources. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/template+
Response Example
{
+ "description": "Hello world HOT template that just defines a single server. Contains just base features to verify base HOT support.\n",
+ "heat_template_version": "2013-05-23",
+ "outputs": {
+ "foo": {
+ "description": "Show foo parameter value",
+ "value": {
+ "get_param": "foo"
+ }
+ }
+ },
+ "parameters": {
+ "foo": {
+ "default": "secret",
+ "description": "Name of an existing key pair to use for the server",
+ "hidden": true,
+ "type": "string"
+ }
+ },
+ "resources": {
+ "random_key_name": {
+ "properties": {
+ "length": 8
+ },
+ "type": "OS::Heat::RandomString"
+ }
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Validating a Template
+Function
This API is used to check whether the template syntax meets requirements.
+Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
environment + |
+body + |
+Json + |
+No + |
+Specifies information about the environment for creating a stack. + |
+
files + |
+body + |
+Json + |
+No + |
+Specifies the files referenced in the environment. + |
+
template + |
+body + |
+Json + |
+No + |
+Specifies the stack template on which operations will be performed. + |
+
Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
description + |
+body + |
+String + |
+Describes the template. + |
+
parameters + |
+body + |
+Dict + |
+Specifies the template parameters. + |
+
Request Example
POST /v1/95d02433133a4c0a87ba6967474a2ad3/validate
+{
+ "template": "heat_template_version: 2014-10-16\ndescription: Create a serious of random string\nparameters:\n length:\n type: number\n default: 4\nresources:\n random:\n type: OS::Heat::RandomString\n properties:\n length: { get_param: length }",
+ "environment": {},
+ "files": {}
+}
+Response Example
{
+ "Description": "Create a serious of random string",
+ "Parameters": {
+ "length": {
+ "Default": 4,
+ "NoEcho": "false",
+ "Type": "Number",
+ "Description": "",
+ "Label": "length"
+ }
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Querying the Template of a Resource Type
+Function
This API is used to query the template of a resource type.
+ The output template parameters of this API are related to the input parameters that you have specified, but the parameters may be different.
+URI
GET /v1/{project_id}/resource_types/{type_name}/template
+For details about the parameters, see Table 1.
+ + +Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
template_type + |
+query + |
+String + |
+No + |
+Specifies the resource template type. +The valid types are cfn and hot. + |
+
Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
outputs + |
+body + |
+Dict + |
+Includes key-value pairs of the output data. + |
+
heat_template_version + |
+body + |
+String + |
+Specifies the version of the HOT template. + |
+
HeatTemplateFormatVersion + |
+body + |
+String + |
+Specifies the version of the CFN template. + |
+
description + |
+body + |
+String + |
+Describes the stack template. + |
+
parameters + |
+body + |
+Dict + |
+Specifies the key-value pairs of template parameters. + |
+
resources + |
+body + |
+Dict + |
+Specifies the template resources. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/resource_types/OS%3A%3AHeat%3A%3ARandomString/template+
Response Example
{
+ "Outputs": {
+ "value": {
+ "Description": "The random string generated by this resource. This value is also available by referencing the resource.",
+ "Value": "{"Fn::GetAtt": ["RandomString", "value"]}"
+ },
+ "show": {
+ "Description": "Detailed information about resource.",
+ "Value": "{"Fn::GetAtt": ["RandomString", "show"]}"
+ }
+ },
+ "HeatTemplateFormatVersion": "2012-12-12",
+ "Resources": {
+ "RandomString": {
+ "Type": "OS::Heat::RandomString",
+ "Properties": {
+ "length": {
+ "Ref": "length"
+ },
+ "salt": {
+ "Ref": "salt"
+ },
+ "character_sequences": {
+ "Fn::Split": [
+ ",",
+ {
+ "Ref": "character_sequences"
+ }
+ ]
+ },
+ "character_classes": {
+ "Fn::Split": [
+ ",",
+ {
+ "Ref": "character_classes"
+ }
+ ]
+ },
+ "sequence": {
+ "Ref": "sequence"
+ }
+ }
+ }
+ },
+ "Description": "Initial template of RandomString",
+ "Parameters": {
+ "length": {
+ "Default": 32,
+ "Type": "Number",
+ "Description": "Length of the string to generate.",
+ "MaxValue": 512,
+ "MinValue": 1
+ },
+ "salt": {
+ "Type": "String",
+ "Description": "Value which can be set or changed on stack update to trigger the resource for replacement with a new random string. The salt value itself is ignored by the random generator."
+ },
+ "character_sequences": {
+ "Type": "CommaDelimitedList",
+ "Description": "A list of character sequences and their constraints to generate the random string from."
+ },
+ "character_classes": {
+ "Default": [
+ {
+ "class": "lettersdigits",
+ "min": 1
+ }
+ ],
+ "Type": "CommaDelimitedList",
+ "Description": "A list of character class and their constraints to generate the random string from."
+ },
+ "sequence": {
+ "Type": "String",
+ "Description": "Sequence of characters to build the random string from.",
+ "AllowedValues": [
+ "lettersdigits",
+ "letters",
+ "lowercase",
+ "uppercase",
+ "digits",
+ "hexdigits",
+ "octdigits"
+ ]
+ }
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Querying the Type of a Resource
+Function
This API is used to query the type of a resource.
+URI
GET /v1/{project_id}/resource_types/{type_name}
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
attributes + |
+body + |
+Dict + |
+Specifies the resource feature dictionary. + |
+
properties + |
+body + |
+Dict + |
+Specifies the resource attributes, including the description and type. + |
+
resource_type + |
+body + |
+String + |
+Specifies the resource type. + |
+
support_status + |
+body + |
+Dict + |
+Specifies the current status. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/resource_types/OS%3A%3AHeat%3A%3ARandomString+
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"
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Querying Resource Types
+Function
This API is used to query resource types.
+Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
resource_types + |
+body + |
+List <str> + |
+Specifies the resource type list. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/resource_types+
Response Example
{
+ "resource_types": [
+ "OS::Nova::Server",
+ "OS::Neutron::Net",
+ "OS::Neutron::Port",
+ "OS::Cinder::VolumeAttachment",
+ "OS::Neutron::RouterInterface",
+ "OS::Neutron::Router"
+ ]
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
Building Information
+ +Querying the Building Information
+Function
This API is used to query the building information.
+Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
api + |
+body + |
+Dict + |
+Specifies the API information. + |
+
engine + |
+body + |
+Dict + |
+Specifies the engine information. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/build_info+
Response Example
{
+ "api": {
+ "revision": "{api_build_revision}"
+ },
+ "engine": {
+ "revision": "{engine_build_revision}"
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
401 + |
+Unauthorized + |
+Authorization failed. + |
+
Software Configuration Management
+ +-
+
- Creating One or More Software Configurations
+
+ - Querying Software Configurations
+
+ - Querying Details of a Software Configuration
+
+ - Deleting a Software Configuration
+
+ - Creating One or More Software Deployments
+
+ - Querying Software Deployments
+
+ - Querying Details of a Software Deployment
+
+ - Updating a Software Deployment
+
+ - Deleting a Software Deployment
+
+ - Viewing Metadata Configured on a Server
+
+
Creating One or More Software Configurations
+Function
This API is used to create one or more software configurations.
+Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
name + |
+body + |
+String + |
+No + |
+Specifies the name of the software configuration. + |
+
config + |
+body + |
+String + |
+No + |
+Specifies the script used for defining the configuration. + |
+
group + |
+body + |
+String + |
+No + |
+Specifies the name of the software configuration group. + |
+
inputs + |
+body + |
+List <dict> + |
+No + |
+Specifies the software configuration input. + |
+
outputs + |
+body + |
+List <dict> + |
+No + |
+Specifies the software configuration output. + |
+
options + |
+body + |
+String + |
+No + |
+Specifies options used by a software configuration management tool. + |
+
Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
software_config + |
+body + |
+Dict + |
+Specifies the software configuration information. + |
+
software_config structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
inputs + |
+body + |
+List <dict> + |
+Specifies the software configuration input. + |
+
name + |
+body + |
+String + |
+Specifies the name of the software configuration. + |
+
outputs + |
+body + |
+List <dict> + |
+Specifies the software configuration output. + |
+
creation_time + |
+body + |
+Date Time + |
+Specifies the time when the configuration was created. + |
+
group + |
+body + |
+String + |
+Specifies the name of the software configuration group. + |
+
config + |
+body + |
+String + |
+Specifies the software configuration code. + |
+
options + |
+body + |
+String + |
+Specifies the software configuration options. + |
+
id + |
+body + |
+String + |
+Specifies the software configuration UUID. + |
+
Request Example
POST /v1/95d02433133a4c0a87ba6967474a2ad3/software_configs
+{
+ "inputs": [
+ {
+ "default": null,
+ "type": "String",
+ "name": "foo",
+ "description": null
+ },
+ {
+ "default": null,
+ "type": "String",
+ "name": "bar",
+ "description": null
+ }
+ ],
+ "group": "script",
+ "name": "a-config-we5zpvyu7b5o",
+ "outputs": [
+ {
+ "type": "String",
+ "name": "result",
+ "error_output": false,
+ "description": null
+ }
+ ],
+ "config": "#!/bin/sh -x\necho \"Writing to /tmp/$bar\"\necho $foo > /tmp/$bar\necho -n \"The file /tmp/$bar contains `cat /tmp/$bar` for server $deploy_server_id during $deploy_action\" > $heat_outputs_path.result\necho \"Written to /tmp/$bar\"\necho \"Output to stderr\" 1>&2",
+ "options": null
+}
+Response Example
{
+ "software_config": {
+ "creation_time": "2015-01-31T15:12:36Z",
+ "inputs": [
+ {
+ "default": null,
+ "type": "String",
+ "name": "foo",
+ "description": null
+ },
+ {
+ "default": null,
+ "type": "String",
+ "name": "bar",
+ "description": null
+ }
+ ],
+ "group": "script",
+ "name": "a-config-we5zpvyu7b5o",
+ "outputs": [
+ {
+ "type": "String",
+ "name": "result",
+ "error_output": false,
+ "description": null
+ }
+ ],
+ "options": null,
+ "config": "#!/bin/sh -x\necho \"Writing to /tmp/$bar\"\necho $foo > /tmp/$bar\necho -n \"The file /tmp/$bar contains `cat /tmp/$bar` for server $deploy_server_id during $deploy_action\" > $heat_outputs_path.result\necho \"Written to /tmp/$bar\"\necho \"Output to stderr\" 1>&2",
+ "id": "ddee7aca-aa32-4335-8265-d436b20db4f1"
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Querying Software Configurations
+Function
This API is used to query the software configurations.
+Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
limit + |
+query + |
+String + |
+No + |
+Specifies the number of returned software configurations. + |
+
marker + |
+query + |
+String + |
+No + |
+Specifies the software configuration from which the next data record starts to be queried. + |
+
Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
software_configs + |
+body + |
+List <dict> + |
+Specifies the software configuration objects. + |
+
software_configs structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
creation_time + |
+body + |
+String + |
+Specifies the creation time. The timestamp uses the ISO 8601 format: +CCYY-MM-DDThh:mm:ss±hh:mm+ |
+
group + |
+body + |
+String + |
+Specifies the name of the software configuration group. + |
+
id + |
+body + |
+String + |
+Specifies the software configuration UUID. + |
+
name + |
+body + |
+String + |
+Specifies the name of the software configuration. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/software_configs+
Response Example
{
+ "software_configs": [
+ {
+ "group": "script",
+ "name": "a-config-we5zpvyu7b5o",
+ "creation_time": "2015-01-31T15:12:36Z",
+ "id": "ddee7aca-aa32-4335-8265-d436b20db4f1",
+ }
+ ]
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Querying Details of a Software Configuration
+Function
This API is used to query details of a software configuration.
+URI
GET /v1/{project_id}/software_configs/{config_id}
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
software_config + |
+body + |
+Dict + |
+Specifies the software configuration list. + |
+
software_config structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
inputs + |
+body + |
+List <dict> + |
+Specifies the software configuration input. + |
+
name + |
+body + |
+String + |
+Specifies the name of the software configuration. + |
+
outputs + |
+body + |
+List <dict> + |
+Specifies the software configuration output. + |
+
creation_time + |
+body + |
+Date Time + |
+Specifies the time when a configuration is created. + |
+
group + |
+body + |
+String + |
+Specifies the name of the software configuration group. + |
+
config + |
+body + |
+String + |
+Specifies the software configuration code. + |
+
options + |
+body + |
+String + |
+Specifies configuration options. + |
+
id + |
+body + |
+String + |
+Specifies the software configuration UUID. + |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/software_configs/40p72423093a900a8b7a669768421a6a+
Response Example
{
+ "software_config": {
+ "inputs": [
+ {
+ "default": null,
+ "type": "String",
+ "name": "foo",
+ "description": null
+ },
+ {
+ "default": null,
+ "type": "String",
+ "name": "bar",
+ "description": null
+ }
+ ],
+ "group": "script",
+ "name": "a-config-we5zpvyu7b5o",
+ "outputs": [
+ {
+ "type": "String",
+ "name": "result",
+ "error_output": false,
+ "description": null
+ }
+ ],
+ "creation_time": "2015-01-31T15:12:36Z",
+ "id": "ddee7aca-aa32-4335-8265-d436b20db4f1",
+ "config": "#!/bin/sh -x\necho \"Writing to /tmp/$bar\"\necho $foo > /tmp/$bar\necho -n \"The file /tmp/$bar contains `cat /tmp/$bar` for server $deploy_server_id during $deploy_action\" > $heat_outputs_path.result\necho \"Written to /tmp/$bar\"\necho \"Output to stderr\" 1>&2",
+ "options": null
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Deleting a Software Configuration
+Function
This API is used to delete a software configuration.
+URI
DELETE /v1/{project_id}/software_configs/{config_id}
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
This request does not return any content in the response body.
+Request Example
DELETE /v1/95d02433133a4c0a87ba6967474a2ad3/software_configs/40p72423093a900a8b7a669768421a6a+
Response Example
None
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
204 + |
+No Content + |
+The RTS service has fulfilled the request by deleting the resource. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
Creating One or More Software Deployments
+Function
This API is used to create one or more software deployments.
+Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
action + |
+body + |
+String + |
+No + |
+Specifies the stack action that triggers this software deployment. + |
+
config_id + |
+body + |
+String + |
+Yes + |
+Specifies the ID of the software configuration running on a server. + |
+
input_values + |
+body + |
+Object + |
+No + |
+Specifies input data stored in the form of a key-value pair. + |
+
server_id + |
+body + |
+String + |
+Yes + |
+Specifies the ID of the server deployed using the software configuration. + |
+
stack_user_project_id + |
+body + |
+String + |
+No + |
+Specifies the ID of the authenticated tenant who can perform operations on the deployment resources. + |
+
status + |
+body + |
+String + |
+No + |
+Specifies the status of software deployments. Valid values include COMPLETE, IN_PROGRESS, and FAILED. + |
+
status_reason + |
+body + |
+String + |
+No + |
+Specifies the cause of the software deployment status. + |
+
Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
software_deployment + |
+body + |
+Dict + |
+Specifies the software deployment resource object. + |
+
software_deployment structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
action + |
+body + |
+String + |
+Specifies the stack action that triggers this software deployment. + |
+
config_id + |
+body + |
+String + |
+Specifies the ID of the software configuration running on a server. + |
+
creation_time + |
+body + |
+String + |
+Specifies the creation time. The timestamp uses the ISO 8601 format: +CCYY-MM-DDThh:mm:ss±hh:mm+ |
+
id + |
+body + |
+String + |
+Specifies the software deployment UUID. + |
+
input_values + |
+body + |
+Object + |
+Specifies input data stored in the form of a key-value pair. + |
+
output_values + |
+body + |
+Object + |
+Specifies output data stored in the form of a key-value pair. + |
+
server_id + |
+body + |
+String + |
+Specifies the server ID. + |
+
status + |
+body + |
+String + |
+Specifies the status of software deployments. Valid values include COMPLETE, IN_PROGRESS, and FAILED. + |
+
status_reason + |
+body + |
+String + |
+Specifies the cause of the software deployment status. + |
+
Request Example
POST /v1/95d02433133a4c0a87ba6967474a2ad3/software_deployments
+{
+ "status": "IN_PROGRESS",
+ "server_id": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
+ "config_id": "8da95794-2ad9-4979-8ae5-739ce314c5cd",
+ "stack_user_project_id": "c024bfada67845ddb17d2b0c0be8cd79",
+ "action": "CREATE",
+ "status_reason": "Deploy data available"
+}
+Response Example
{
+ "software_deployment": {
+ "status": "IN_PROGRESS",
+ "server_id": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
+ "config_id": "8da95794-2ad9-4979-8ae5-739ce314c5cd",
+ "output_values": null,
+ "input_values": null,
+ "action": "CREATE",
+ "status_reason": "Deploy data available",
+ "id": "ef422fa5-719a-419e-a10c-72e3a367b0b8",
+ "creation_time": "2015-01-31T15:12:36Z"
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Querying Software Deployments
+Function
This API is used to query software deployments.
+Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
server_id + |
+query + |
+String + |
+No + |
+Specifies the target server ID. + |
+
Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
software_deployments + |
+body + |
+List <dict> + |
+Specifies the software deployment resource object. + |
+
software_deployments structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
action + |
+body + |
+String + |
+Specifies the stack action that triggers this software deployment resource. + |
+
config_id + |
+body + |
+String + |
+Specifies the ID of the software configuration running on a server. + |
+
creation_time + |
+body + |
+String + |
+Specifies the creation time. The timestamp uses the ISO 8601 format: +CCYY-MM-DDThh:mm:ss±hh:mm+ |
+
id + |
+body + |
+String + |
+Specifies the software deployment UUID. + |
+
input_values + |
+body + |
+Object + |
+Specifies input data stored in the form of a key-value pair. + |
+
output_values + |
+body + |
+Object + |
+Specifies output data stored in the form of a key-value pair. + |
+
server_id + |
+body + |
+String + |
+Specifies the server ID. + |
+
status + |
+body + |
+String + |
+Specifies the current status of software deployments. Valid values include COMPLETE, IN_PROGRESS, and FAILED. + |
+
status_reason + |
+body + |
+String + |
+Specifies the cause of the software deployment resource status. + |
+
updated_time + |
+body + |
+String + |
+Specifies the update time. The timestamp uses the ISO 8601 format: +CCYY-MM-DDThh:mm:ss±hh:mm+ |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/software_deployments+
Response Example
{
+ "software_deployments": [
+ {
+ "status": "COMPLETE",
+ "server_id": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
+ "config_id": "8da95794-2ad9-4979-8ae5-739ce314c5cd",
+ "output_values": {
+ "deploy_stdout": "Writing to /tmp/barmy\nWritten to /tmp/barmy\n",
+ "deploy_stderr": "+ echo Writing to /tmp/barmy\n+ echo fu\n+ cat /tmp/barmy\n+ echo -n The file /tmp/barmy contains fu for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE\n+ echo Written to /tmp/barmy\n+ echo Output to stderr\nOutput to stderr\n",
+ "deploy_status_code": 0,
+ "result": "The file /tmp/barmy contains fu for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE"
+ },
+ "input_values": null,
+ "action": "CREATE",
+ "status_reason": "Outputs received",
+ "id": "ef422fa5-719a-419e-a10c-72e3a367b0b8",
+ "creation_time": "2015-01-31T15:12:36Z",
+ "updated_time": "2015-01-31T15:18:21Z"
+ }
+ ]
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Querying Details of a Software Deployment
+Function
This API is used to query details of a software deployment.
+URI
GET /v1/{project_id}/software_deployments/{deployment_id}
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
software_deployment + |
+body + |
+List <dict> + |
+Specifies the software deployment objects. + |
+
software_deployment structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
action + |
+body + |
+String + |
+Specifies the stack action that triggers the software deployment. + |
+
config_id + |
+body + |
+String + |
+Specifies the ID of the software configuration running on a server. + |
+
creation_time + |
+body + |
+String + |
+Specifies the creation time. The timestamp uses the ISO 8601 format: +CCYY-MM-DDThh:mm:ss±hh:mm+ |
+
id + |
+body + |
+String + |
+Specifies the software deployment UUID. + |
+
input_values + |
+body + |
+Object + |
+Specifies input data stored in the form of a key-value pair. + |
+
output_values + |
+body + |
+Object + |
+Specifies output data stored in the form of a key-value pair. + |
+
server_id + |
+body + |
+String + |
+Specifies the server ID. + |
+
status + |
+body + |
+String + |
+Specifies the current status of software deployments. Valid values include COMPLETE, IN_PROGRESS, and FAILED. + |
+
status_reason + |
+body + |
+String + |
+Specifies the cause of the software deployment status. + |
+
updated_time + |
+body + |
+String + |
+Specifies the update time. The timestamp uses the ISO 8601 format: +CCYY-MM-DDThh:mm:ss±hh:mm+ |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/software_deployments/3d5ec2a8-7004-43b6-a7f6-542bdbe9d434+
Response Example
{
+ "software_deployment": {
+ "action": "CREATE",
+ "config_id": "619d6e53-e14b-497f-8852-9c2671b07d79",
+ "creation_time": "2018-05-15T08:48:23.500895",
+ "id": "bb51252e-3e80-4be9-8c06-c52a88e87ec8",
+ "input_values": {},
+ "output_values": null,
+ "server_id": "ca839c6d-c038-46b6-b0b8-8ce78e715639",
+ "status": "IN_PROGRESS",
+ "status_reason": "Deploy data available"
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Updating a Software Deployment
+Function
This API is used to update a software deployment.
+URI
PUT /v1/{project_id}/software_deployments/{deployment_id}
+For details about the parameters, see Table 1.
+ + +Request Parameter
+Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
action + |
+body + |
+String + |
+No + |
+Specifies the stack action that triggers this software deployment. + |
+
config_id + |
+body + |
+String + |
+No + |
+Specifies the ID of the software configuration running on a server. + |
+
input_values + |
+body + |
+Object + |
+No + |
+Specifies input data stored in the form of a key-value pair. + |
+
output_values + |
+body + |
+Object + |
+No + |
+Specifies output data stored in the form of a key-value pair. + |
+
status + |
+body + |
+String + |
+No + |
+Specifies the status of software deployments. Valid values include COMPLETE, IN_PROGRESS, and FAILED. + |
+
status_reason + |
+body + |
+String + |
+No + |
+Specifies the cause of the software deployment status. + |
+
Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
software_deployment + |
+body + |
+Dict + |
+Specifies the software deployment resource object. + |
+
software_deployment structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
action + |
+body + |
+String + |
+Specifies the stack action that triggers this software deployment. + |
+
config_id + |
+body + |
+String + |
+Specifies the ID of the software configuration running on a server. + |
+
creation_time + |
+body + |
+String + |
+Specifies the creation time. The timestamp uses the ISO 8601 format: +CCYY-MM-DDThh:mm:ss±hh:mm+ |
+
id + |
+body + |
+String + |
+Specifies the software deployment UUID. + |
+
input_values + |
+body + |
+Object + |
+Specifies input data stored in the form of a key-value pair. + |
+
output_values + |
+body + |
+Object + |
+Specifies output data stored in the form of a key-value pair. + |
+
server_id + |
+body + |
+String + |
+Specifies the server ID. + |
+
status + |
+body + |
+String + |
+Specifies the status of software deployments. Valid values include COMPLETE, IN_PROGRESS, and FAILED. + |
+
status_reason + |
+body + |
+String + |
+Specifies the cause of the software deployment status. + |
+
updated_time + |
+body + |
+String + |
+Specifies the update time. The timestamp uses the ISO 8601 format: +CCYY-MM-DDThh:mm:ss±hh:mm+ |
+
Request Example
PUT /v1/95d02433133a4c0a87ba6967474a2ad3/software_deployments/3d5ec2a8-7004-43b6-a7f6-542bdbe9d434
+{
+ "status": "COMPLETE",
+ "output_values": {
+ "deploy_stdout": "Writing to /tmp/baaaaa\nWritten to /tmp/baaaaa\n",
+ "deploy_stderr": "+ echo Writing to /tmp/baaaaa\n+ echo fooooo\n+ cat /tmp/baaaaa\n+ echo -n The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE\n+ echo Written to /tmp/baaaaa\n+ echo Output to stderr\nOutput to stderr\n",
+ "deploy_status_code": 0,
+ "result": "The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE"
+ },
+ "status_reason": "Outputs received"
+}
+Response Example
{
+ "software_deployment": {
+ "status": "COMPLETE",
+ "server_id": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
+ "config_id": "3d5ec2a8-7004-43b6-a7f6-542bdbe9d434",
+ "output_values": {
+ "deploy_stdout": "Writing to /tmp/baaaaa\nWritten to /tmp/baaaaa\n",
+ "deploy_stderr": "+ echo Writing to /tmp/baaaaa\n+ echo fooooo\n+ cat /tmp/baaaaa\n+ echo -n The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE\n+ echo Written to /tmp/baaaaa\n+ echo Output to stderr\nOutput to stderr\n",
+ "deploy_status_code": 0,
+ "result": "The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE"
+ },
+ "input_values": null,
+ "action": "CREATE",
+ "status_reason": "Outputs received",
+ "id": "06e87bcc-33a2-4bce-aebd-533e698282d3",
+ "creation_time": "2015-01-31T15:12:36Z",
+ "updated_time": "2015-01-31T15:18:21Z"
+ }
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Deleting a Software Deployment
+Function
This API is used to delete a software deployment.
+URI
DELETE /v1/{project_id}/software_deployments/{deployment_id}
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
This request does not return any content in the response body.
+Request Example
DELETE /v1/95d02433133a4c0a87ba6967474a2ad3/software_deployments/80p72409093a9005bb7a6698c85a1b61+
Response Example
None
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
204 + |
+No Content + |
+The RTS service has fulfilled the request by deleting the resource. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Viewing Metadata Configured on a Server
+Function
This API is used to view the metadata configured on a server.
+URI
GET /v1/{project_id}/software_deployments/metadata/{server_id}
+For details about the parameters, see Table 1.
+ + +Request Parameter
N/A
+Response Parameter
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
metadata + |
+body + |
+List <dict> + |
+Specifies the software deployment metadata. + |
+
metadata structure information
+ +Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
config + |
+body + |
+String + |
+Specifies the configuration script or list. + |
+
creation_time + |
+body + |
+String + |
+Specifies the creation time. The timestamp uses the ISO 8601 format: +CCYY-MM-DDThh:mm:ss±hh:mm+ |
+
group + |
+body + |
+String + |
+Specifies the name of the software configuration group. + |
+
id + |
+body + |
+String + |
+Specifies the software configuration UUID. + |
+
inputs + |
+body + |
+List <dict> + |
+Specifies the software configuration input. + |
+
name + |
+body + |
+String + |
+Specifies the name of the software configuration. + |
+
options + |
+body + |
+String + |
+Contains mapping for the options of the software management tool that this resource uses. + |
+
outputs + |
+body + |
+List <dict> + |
+Specifies the software configuration output. + |
+
updated_time + |
+body + |
+String + |
+Specifies the update time. The timestamp uses the ISO 8601 format: +CCYY-MM-DDThh:mm:ss±hh:mm+ |
+
Request Example
GET /v1/95d02433133a4c0a87ba6967474a2ad3/software_deployments/metadata/6a5eca38-6a04-4b26-6af5-543cdbd3d5e4+
Response Example
{
+ "metadata": [
+ {
+ "inputs": [
+ {
+ "default": null,
+ "type": "String",
+ "name": "foo",
+ "value": "fooooo",
+ "description": null
+ },
+ {
+ "default": null,
+ "type": "String",
+ "name": "bar",
+ "value": "baaaaa",
+ "description": null
+ },
+ {
+ "type": "String",
+ "name": "deploy_server_id",
+ "value": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
+ "description": "ID of the server being deployed to"
+ },
+ {
+ "type": "String",
+ "name": "deploy_action",
+ "value": "CREATE",
+ "description": "Name of the current action being deployed"
+ },
+ {
+ "type": "String",
+ "name": "deploy_stack_id",
+ "value": "a/9bd57090-8954-48ab-bab9-adf9e1ac70fc",
+ "description": "ID of the stack this deployment belongs to"
+ },
+ {
+ "type": "String",
+ "name": "deploy_resource_name",
+ "value": "deployment",
+ "description": "Name of this deployment resource in the stack"
+ },
+ {
+ "type": "String",
+ "name": "deploy_signal_id",
+ "value": "http://x.x.x.x:8000/v1/signal/arn%3Aopenstack%3Aheat%3A%3Ae2a84fbdaeb047ae8da4b503f3b69f1f%3Astacks%2Fa%2F9bd57090-8954-48ab-bab9-adf9e1ac70fc%2Fresources%2Fdeployment?Timestamp=2014-03-19T20%3A30%3A59Z&SignatureMethod=HmacSHA256&AWSAccessKeyId=ca3571413e4a49998d580215517b3685&SignatureVersion=2&Signature=w6Iu%2BNbg86mqwSOUf1GLuKPO7KaD82PiGpL4ig9Q1l4%3D",
+ "description": "ID of signal to use for signalling output values"
+ }
+ ],
+ "group": "script",
+ "name": "a-config-we5zpvyu7b5o",
+ "outputs": [
+ {
+ "type": "String",
+ "name": "result",
+ "error_output": false,
+ "description": null
+ }
+ ],
+ "options": null,
+ "creation_time": "2015-01-31T15:12:36Z",
+ "updated_time": "2015-01-31T15:18:21Z",
+ "config": "#!/bin/sh -x\necho \"Writing to /tmp/$bar\"\necho $foo > /tmp/$bar\necho -n \"The file /tmp/$bar contains `cat /tmp/$bar` for server $deploy_server_id during $deploy_action\" > $heat_outputs_path.result\necho \"Written to /tmp/$bar\"\necho \"Output to stderr\" 1>&2",
+ "id": "3d5ec2a8-7004-43b6-a7f6-542bdbe9d434"
+ },
+ {
+ "inputs": [
+ {
+ "default": null,
+ "type": "String",
+ "name": "foo",
+ "value": "fu",
+ "description": null
+ },
+ {
+ "default": null,
+ "type": "String",
+ "name": "bar",
+ "value": "barmy",
+ "description": null
+ },
+ {
+ "type": "String",
+ "name": "deploy_server_id",
+ "value": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
+ "description": "ID of the server being deployed to"
+ },
+ {
+ "type": "String",
+ "name": "deploy_action",
+ "value": "CREATE",
+ "description": "Name of the current action being deployed"
+ },
+ {
+ "type": "String",
+ "name": "deploy_stack_id",
+ "value": "a/9bd57090-8954-48ab-bab9-adf9e1ac70fc",
+ "description": "ID of the stack this deployment belongs to"
+ },
+ {
+ "type": "String",
+ "name": "deploy_resource_name",
+ "value": "other_deployment",
+ "description": "Name of this deployment resource in the stack"
+ },
+ {
+ "type": "String",
+ "name": "deploy_signal_id",
+ "value": "http://x.x.x.x:8000/v1/signal/arn%3Aopenstack%3Aheat%3A%3Ae2a84fbdaeb047ae8da4b503f3b69f1f%3Astacks%2Fa%2F9bd57090-8954-48ab-bab9-adf9e1ac70fc%2Fresources%2Fother_deployment?Timestamp=2014-03-19T20%3A30%3A59Z&SignatureMethod=HmacSHA256&AWSAccessKeyId=7b761482f8254946bcd3d5ccb36fe939&SignatureVersion=2&Signature=giMfv%2BhrAw6y%2FCMKQIQz2IhO5PkAj5%2BfP5YsL6rul3o%3D",
+ "description": "ID of signal to use for signalling output values"
+ }
+ ],
+ "group": "script",
+ "name": "a-config-we5zpvyu7b5o",
+ "outputs": [
+ {
+ "type": "String",
+ "name": "result",
+ "error_output": false,
+ "description": null
+ }
+ ],
+ "options": null,
+ "creation_time": "2015-01-31T16:14:13Z",
+ "updated_time": "2015-01-31T16:18:19Z",
+ "config": "#!/bin/sh -x\necho \"Writing to /tmp/$bar\"\necho $foo > /tmp/$bar\necho -n \"The file /tmp/$bar contains `cat /tmp/$bar` for server $deploy_server_id during $deploy_action\" > $heat_outputs_path.result\necho \"Written to /tmp/$bar\"\necho \"Output to stderr\" 1>&2",
+ "id": "8da95794-2ad9-4979-8ae5-739ce314c5cd"
+ }
+ ]
+}
+Return Code
+Return Code + |
+Type + |
+Description + |
+
|---|---|---|
200 + |
+OK + |
+Request was successful. + |
+
Return Code + |
+Type + |
+Description + |
+
|---|---|---|
400 + |
+Bad Request + |
+The server failed to process the request. + |
+
401 + |
+Unauthorized + |
+Authorization failed. + |
+
404 + |
+Not found + |
+The requested resources are not found. + |
+
500 + |
+Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
Resource Type Management
+ +-
+
- Querying Resource Types
+
+ - Querying the Template of a Resource Type
+
+ - Querying the Type of a Resource
+
+