c9f5ad3bcf
As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
150 lines
3.8 KiB
ReStructuredText
150 lines
3.8 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
Get Rdp Console (os-getRDPConsole Action)
|
|
=========================================
|
|
|
|
.. rest_method:: POST /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: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
|
|
conflict(409), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- 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 /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: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
|
|
conflict(409), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- 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 /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: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
|
|
conflict(409), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- 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 /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: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
|
|
conflict(409), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- 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
|
|
|