Show VNC Console

Summary

Show VNC Console.

Type

  • Show

Synchronous/Asynchronous

  • Synchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{api_endpoint}/v1.0/virtual_network_appliances/{virtual_network_appliance_id}/remote-console

HTTP Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>

HTTP Request Body

Parameters

Input Parameters
name style datatype format description required/optional default value action for invalid parameter response code for invalid parameter
token_id Header String Non-Hyph-uuid keystone authentication token required   Terminate 401
virtual_network_appliance_id URL String Hyph-uuid ID of the Virtual_Network_Appliance required   Terminate 404
os-getVNCConsole Body Object -   required   Terminate 400
type Body String String(0-255) Type of vnc required   Terminate 400

Response

Response Header

Format

HTTP/1.1 <response_code> <message>       (ex. 200 OK)
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

Response Code

Response Codes
response code condition
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error

Response Body

Format

{
  "console": {
    "type": "<vnc_type>",
    "url": "<console_URL>"
  }
}

Parameters

Response Parameters
item datatype format description
console Object -  
type String String(0-255) Type of vnc
url URL - console URL

Sample Request and Response

Sample API Request

Request URI

https://{api_endpoint}/v1.0/virtual_network_appliances/{virtual_network_appliance_id}/remote-console

Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: 69105c889f824efdafb56af224208ad4

Request Body

{
  "os-getVNCConsole": {
    "type": "novnc"
  }
}

Sample API Response

Response Header

HTTP/1.1 200 OK

Response Body

{
  "console": {
    "url": "https://nova-vnc-lab3ec.gcv-cloud.com/vnc_auto.html?token=65702f93-da9d-4881-83f0-0506f1dbd4fd",
    "type": "novnc"
  }
}

Example Error Message

HTTP Request

POST /v1.0/virtual_network_appliances/{virtual_network_appliance_id}/remote-console HTTP/1.1
User-Agent: curl/7.51.0
Host: 10.1.131.140
Accept:application/json
X-Auth-Token:4e54395a12b740d585d74190ba4eb14b
Content-Type: application/json

HTTP Response

HTTP/1.1 404 Not Found
Server: nginx
Date: Wed, 07 Feb 2018 06:49:20 GMT
Content-Type: application/json
Content-Length: 25
Connection: keep-alive

{
    "message": "Not Found."
}