623c5a5354
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
204 lines
3.4 KiB
ReStructuredText
204 lines
3.4 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=============
|
|
Stack actions
|
|
=============
|
|
|
|
Performs non-lifecycle operations on the stack. Specify the action in the
|
|
request body.
|
|
|
|
Suspend stack
|
|
=============
|
|
|
|
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
|
|
|
|
Suspends a stack.
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error 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
|
|
- suspend: suspend
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/stack-action-suspend-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- X-Openstack-Request-Id: request_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
This operation does not return a response body.
|
|
|
|
|
|
Resume stack
|
|
============
|
|
|
|
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
|
|
|
|
Resumes a suspended stack.
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error 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
|
|
- resume: resume
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/stack-action-resume-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- X-Openstack-Request-Id: request_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
This operation does not return a response body.
|
|
|
|
|
|
Cancel stack update
|
|
===================
|
|
|
|
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
|
|
|
|
Cancels a currently running update of a stack.
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error 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
|
|
- cancel_update: cancel_update
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/stack-action-cancel-update-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- X-Openstack-Request-Id: request_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
This operation does not return a response body.
|
|
|
|
|
|
Check stack resources
|
|
=====================
|
|
|
|
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
|
|
|
|
Checks whether the resources are in expected states for a stack.
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error 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
|
|
- check: check
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/stack-action-check-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- X-Openstack-Request-Id: request_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
This operation does not return a response body.
|