• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference

Obtaining the VNC Login Address

Function Description

This interface is used to obtain the address for remotely logging in to an ECS using VNC.

URI

  • URI format

    POST /v2/{tenant_id}/servers/{server_id}/action

    POST /v2.1/{tenant_id}/servers/{server_id}/action

  • Parameter description

    Parameter

    Mandatory

    Description

    tenant_id

    Yes

    Specifies the tenant or project ID.

    server_id

    Yes

    Specifies the ECS ID.

Restrictions

This interface will become invalid from micro version 2.5 and will be replaced by the remote API console in micro version 2.6.

Extension Description

N/A

Request

Table 1 Request parameter

Parameter

Type

Mandatory

Description

os-getVNCConsole

Dict

Yes

Obtains the address for remotely logging in to an ECS using VNC.

Table 2 type parameters

Parameter

Type

Mandatory

Description

type

String

Yes

Specifies the object. Set the value to novnc.

Response

N/A

Example Request

POST /v2/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action
POST /v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action
{
   "os-getVNCConsole" : {
        "type" : "novnc"
    }
}

Response Example

{
    "console":{"url": "https://nova-novncproxy.az21.dc1.domainname.com:8002/vnc.auto.html?token=80fa7c8d-37fe-451e-8b08-bfbd9fb6a4df&lang=EN","type":"novnc"}
}

Returned Values

See General Request Returned Values.

Error Code

See Error Code Description.