• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. Status Management
  6. Obtaining a VNC-based Remote Login Address (Microversion 2.5 or Earlier)

Obtaining a VNC-based Remote Login Address (Microversion 2.5 or Earlier)

Function

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

URI

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

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

server_id

Yes

Specifies the ECS ID.

Constraints

This API will be discarded since a version later than microversion 2.5. When using this API, set the microversion to 2.5 or earlier.

Request

Request parameters

Table 2 describes the request parameters.
Table 2 Request parameter

Parameter

Type

Mandatory

Description

os-getVNCConsole

Dict

Yes

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

Table 3 type parameters

Parameter

Type

Mandatory

Description

type

String

Yes

Specifies the object. Set the value to novnc.

Response

N/A

Examples

  • 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"
        }
    }
  • Example response
    {
        "console":{"url": "https://console.huaweicloud.com:443/az1.dz1/vnc_auto.html?token=80fa7c8d-37fe-451e-8b08-bfbd9fb6a4df&lang=EN","type":"novnc"}
    }

Returned Values

See General Request Returned Values.

Error Codes

See Error Code Description.