Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Remotely Logging In to the Console
Updated on 2026-02-10 GMT+08:00
View PDF
Share

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:desktops:createConsole

    Write

    desktop *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

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

None

Response Parameters

Status code: 200

Table 2 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 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

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

GET /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.

Parent topic: Desktop