openstack/heat
Code Issues Proposed changes
ba86557ed2
heat/api-ref/source/v1/resources.inc
tengqm 623c5a5354 api-ref - stack actions 
This patch fixes problems found in api-ref documentation related
to stack actions and missing stack APIs. More specifically, this
include the following changes:

- Fix status code documentation about stack actions;
- Added response parameters for some actions although there is no
  body returned -- there are still header returned;
- Added documentation about stack-export API;
- Added documentation about stack-environment-show API;
- Added documentation about stack-files-show API;

Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-22 06:59:12 +00:00

299 lines
5.9 KiB
ReStructuredText
Raw Blame History

.. -*- rst -*-
===============
Stack resources
===============
Find stack resources
====================
.. rest_method:: GET /v1/{tenant_id}/stacks/{stack_identity}/resources
Finds the canonical URL for a resource list of a stack.
The canonical URL is returned for only non-deleted stacks. To fetch
the resource list for deleted stacks, use the following endpoint:
::
/v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 302
.. rest_status_code:: success status.yaml
- 401
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- stack_identity: stack_identity
Response Parameter
------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- location: location
Response Example
----------------
.. literalinclude:: samples/stack-find-response.json
:language: javascript
List stack resources
====================
.. rest_method:: GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources
Lists resources in a stack based on filtering parameters like resource
name, status, type, action, id and physical_resource_id. These parameters could
be used multiple times.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: success status.yaml
- 400
- 401
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- stack_name: stack_name_url
- stack_id: stack_id_url
- type: resource_type_query
- status: resource_status_query
- name: resource_name_query
- action: resource_action_query
- id: resource_id_query
- physical_resource_id: physical_resource_id_query
- nested_depth: nested_depth
- with_detail: with_detail
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- resources: resources_list
- creation_time: creation_time
- links: links
- logical_resource_id: logical_resource_id
- physical_resource_id: physical_resource_id
- required_by: required_by
- resource_name: resource_name
- resource_status: resource_status
- resource_status_reason: resource_status_reason
- resource_type: resource_type
- updated_time: updated_time
Response Example
----------------
.. literalinclude:: samples/resources-list-response.json
:language: javascript
Show resource data
==================
.. rest_method:: GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}
Shows data for a resource.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: success status.yaml
- 400
- 401
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- stack_name: stack_name_url
- stack_id: stack_id_url
- resource_name: resource_name_url
- with_attr: with_attr
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- resource: resource
- attributes: attributes
- creation_time: creation_time
- description: description
- links: resource_links
- logical_resource_id: logical_resource_id
- physical_resource_id: physical_resource_id
- required_by: required_by
- resource_name: resource_name
- resource_status: resource_status
- resource_status_reason: resource_status_reason
- resource_type: resource_type
- updated_time: updated_time
Response Example
----------------
.. literalinclude:: samples/resource-show-response.json
:language: javascript
Show resource metadata
======================
.. rest_method:: GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/metadata
Shows metadata for a resource.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: success status.yaml
- 400
- 401
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- stack_name: stack_name_url
- stack_id: stack_id_url
- resource_name: resource_name_url
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- metadata: metadata
Response Example
----------------
.. literalinclude:: samples/resource-metadata-response.json
:language: javascript
Send a signal to a resource
===========================
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/signal
Sends a signal to a resource.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: success status.yaml
- 400: resource_signal
- 401
- 404
Request Parameters
------------------
The contents of the request body depends on the resource to which you send a
signal.
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- stack_name: stack_name_url
- stack_id: stack_id_url
- resource_name: resource_name_url
Response Example
----------------
This operation does not return a response body.
Mark a resource as unhealthy
============================
.. rest_method:: PATCH /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}
Mark the specified resource in the stack as unhealthy.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: success status.yaml
- 400
- 401
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- stack_name: stack_name_url
- stack_id: stack_id_url
- resource_name: resource_name_url
- mark_unhealthy: mark_unhealthy
- resource_status_reason: resource_update_status_reason
Response Example
----------------
This operation does not return a response body.
View Git Blame Copy Permalink