diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2019-10-10 15:13:06 +0100 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2019-11-22 16:09:36 +0000 |
| commit | 3062a1199d9bc3aa1c663a94582db2da5b36c54e (patch) | |
| tree | ac65ebebe127a16039b72ca299378b20afaae78f /api-ref/source/os-consoles.inc | |
| parent | 991d675675c1c6bb87a2b9d19327e2b4473f6c0b (diff) | |
| download | nova-3062a1199d9bc3aa1c663a94582db2da5b36c54e.tar.gz | |
Remove 'os-consoles' API
This exposes the 'nova-console' service via a REST API, a service that
can only be used with XVP VNC consoles, which in turn require the
'nova-xvpvncproxy' service. We we would like to remove the
'nova-console' and 'nova-xvpvncproxy' services, so start here.
Part of blueprint remove-xvpvncproxy
Change-Id: I2ee3b8c44e5d85e9b3c811ed3c5e6cddc563054f
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Diffstat (limited to 'api-ref/source/os-consoles.inc')
| -rw-r--r-- | api-ref/source/os-consoles.inc | 69 |
1 files changed, 15 insertions, 54 deletions
diff --git a/api-ref/source/os-consoles.inc b/api-ref/source/os-consoles.inc index b19bf70665..fe3c654589 100644 --- a/api-ref/source/os-consoles.inc +++ b/api-ref/source/os-consoles.inc @@ -1,12 +1,15 @@ .. -*- rst -*- -=============================================================== - Server consoles (servers, os-consoles, os-console-auth-tokens) -=============================================================== +================================================== + XenServer VNC Proxy (XVP) consoles (os-consoles) +================================================== -Manages server consoles. +Manages server XVP consoles. -.. note:: This is only used in Xenserver VNC Proxy. +.. warning:: + + These APIs are only applicable when using the XenServer virt driver. + They were removed in the 21.0.0 (Ussuri) release. Lists Consoles ============== @@ -17,7 +20,7 @@ Lists all consoles for a server. Normal response codes: 200 -Error response codes: unauthorized(401), forbidden(403) +Error response codes: unauthorized(401), forbidden(403), gone(410) Request ------- @@ -53,7 +56,8 @@ Creates a console for a server. Normal response codes: 200 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410) Request ------- @@ -77,7 +81,8 @@ Shows console details for a server. Normal response codes: 200 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410) Request ------- @@ -117,7 +122,8 @@ Deletes a console for a server. Normal response codes: 202 -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), +gone(410) Request ------- @@ -132,48 +138,3 @@ Response -------- If successful, this method does not return a response body. - - -Show Console Connection Information -=================================== - -.. rest_method:: GET /os-console-auth-tokens/{console_token} - -Given the console authentication token for a server, -shows the related connection information. - -This method used to be available only for the ``rdp-html5`` console type before -microversion 2.31. Starting from microversion 2.31 it's available for all -console types. - -Normal response codes: 200 - -Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404) - -Request -------- - -.. rest_parameters:: parameters.yaml - - - - console_token: console_token - -| - -Response --------- - -.. rest_parameters:: parameters.yaml - - - console: console - - instance_uuid: instance_id_body - - host: console_host - - port: port_number - - internal_access_path: internal_access_path - -| - -**Example Show Console Authentication Token** - -.. literalinclude:: ../../doc/api_samples/os-console-auth-tokens/get-console-connect-info-get-resp.json - :language: javascript |