Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Remotely Logging In to the Console
Updated on 2025-07-14 GMT+08:00

Remotely Logging In to the Console

Function

Obtains the address for remotely logging in to the console.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/desktops/{desktop_id}/remote-consoles

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

desktop_id

Yes

String

Desktop ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

No

String

MIME type of the request body.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

type

String

Login type.

url

String

Obtains the URL for remote login to the console.

protocol

String

Login protocol.

Status code: default

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

/v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/2b31e-d520xxxx-xxebedb6-e57xxxxxx/remote-consoles

Example Responses

Status code: 200

Response body of the request for querying the address for remotely logging in to the console.

{
  "type" : "novnc",
  "url" : "https://console.xxx.huawei.com/vnc/xxx/vnc_auto.html?token=803xxxx-704b-4xxx-bbb8-82907cxxx77&lang=EN"
}

Status Codes

Status Code

Description

200

Response body of the request for querying the address for remotely logging in to the console.

default

Default error response.

Error Codes

See Error Codes.