d929b9fc76
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
151 lines
4.1 KiB
ReStructuredText
151 lines
4.1 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:method_verification
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
Get Rdp Console (Os-Getrdpconsole Action)
|
|
=========================================
|
|
|
|
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
|
|
|
|
Gets an `RDP <https://technet.microsoft.com/en-us/windowsserver/ee236407>`__ console for a server.
|
|
|
|
Specify the ``os-getRDPConsole`` 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-getRDPConsole: os-getRDPConsole
|
|
|
|
**Example Get Rdp Console (Os-Getrdpconsole Action): JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Get Rdp Console (Os-Getrdpconsole Action): JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-resp.json
|
|
:language: javascript
|
|
|
|
Get Serial Console (Os-Getserialconsole Action)
|
|
===============================================
|
|
|
|
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
|
|
|
|
Gets a serial console for a server.
|
|
|
|
Specify the ``os-getSerialConsole`` 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-getSerialConsole: os-getSerialConsole
|
|
|
|
**Example Get Serial Console (Os-Getserialconsole Action): JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-serial-console-post-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Get Serial Console (Os-Getserialconsole Action): JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-serial-console-post-resp.json
|
|
:language: javascript
|
|
|
|
Get Spice Console (Os-Getspiceconsole Action)
|
|
=============================================
|
|
|
|
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
|
|
|
|
Gets a SPICE console for a server.
|
|
|
|
Specify the ``os-getSPICEConsole`` 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-getSPICEConsole: os-getSPICEConsole
|
|
|
|
**Example Get Spice Console (Os-Getspiceconsole Action): JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-spice-console-post-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Get Spice Console (Os-Getspiceconsole Action): JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-spice-console-post-resp.json
|
|
:language: javascript
|
|
|
|
Get Vnc Console (Os-Getvncconsole Action)
|
|
=========================================
|
|
|
|
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
|
|
|
|
Gets a VNC console for a server.
|
|
|
|
Specify the ``os-getVNCConsole`` 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-getVNCConsole: os-getVNCConsole
|
|
|
|
**Example Get Vnc Console (Os-Getvncconsole Action): JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-vnc-console-post-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Get Vnc Console (Os-Getvncconsole Action): JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-vnc-console-post-resp.json
|
|
:language: javascript
|
|
|