nova/api-ref/source/servers-action-console-output.inc
Sean Dague d929b9fc76 add tags to files for the content verification phase
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef

Part of bp:api-ref-in-rst

Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016-04-20 16:21:58 -04:00

44 lines
1.1 KiB
ReStructuredText

.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
Show Console Output (Os-Getconsoleoutput Action)
================================================
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
Shows console output for a server instance.
Specify the ``os-getConsoleOutput`` action in the request body.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
- os-getConsoleOutput: os-getConsoleOutput
- length: length
**Example Get console output: JSON request**
.. literalinclude:: ../../doc/api_samples/os-console-output/console-output-post-req.json
:language: javascript
Response
--------
**Example Get console output: JSON response**
.. literalinclude:: ../../doc/api_samples/os-console-output/console-output-post-resp.json
:language: javascript