Help Center/Cloud Data Center/API Reference/API/Physical Server Management/Obtaining the Console Address
Updated on 2025-12-19 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Console Address

Function

This API is used to obtain console information.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/physicalservers/{id}/remote-console-address

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID.

Constraints

N/A

Range

Project ID of the account.

Default Value

N/A

id

Yes

String

Definition

Server ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

url

String

Definition

Remote login address.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Status code: 429

Table 6 Response body parameters

Parameter

Type

Description

-

String

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Example Requests

Obtaining the console information

GET https://{endpoint}/v1/{project_id}/physicalservers/{id}/remote-console-address

Example Responses

Status code: 200

The request has succeeded.

{
  "url" : "https://cn-southwest-242-console.huaweicloud.com:443/vnc/testjarvis.cn-southwest-242/vnc_auto.html?token=2e3e42cb-b5e7-49f0-91b6-d16401a823ac&compression=9&quality=0&resize=scale"
}

Status Codes

Status Code

Description

200

The request has succeeded.

400

Invalid request parameter.

401

The request is not authenticated.

429

The request is overloaded.

500

Internal server error.

Error Codes

See Error Codes.