Call the DescribeInstanceVncUrl operation to query the VNC management terminal address of an ECS instance.

Usage notes

If you cannot use the ECS Terminal to log in to a Linux instance, log in to the instance via VNC in the console to view the real-time status of the ECS operation interface.

You can generate a VNC login link (JS format) by performing the following operation:

Add Region=****, host=****, and name=**** to the end of https://iaas-api.console.volcengine.com/ecs/connect/vnc/?. Separate the parameters with &.

Name	Description	Sample value
Region	The region of the instance.	cn-beijing
host	The value of VncUrl returned by calling the DescribeInstanceVncUrl operation.	cn-beijing-a01-vncproxy-ecs.volcengine.com:443/websockify/destInfoToken/01495659-06ab-49ca-9aa7-d1b226*******
name	Instance name.	instance-host-name

Sample link (JS format):

https://iaas-api.console.volcengine.com/ecs/connect/vnc/?Region=cn-beijing&host=cn-beijing-a01-vncproxy-ecs.volcengine.com:443/websockify/destInfoToken/01495659-06ab-49ca-9aa7-d1b226*******&name=instance-host-name

After you log in to the instance via VNC, if there is no interactive operation within 180 seconds in your management terminal window, the connection will be automatically disconnected.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The table below lists only the request parameters specific to this operation and some common parameters. For more information, please refer to Common parameters.

Action string required Sample value: DescribeInstanceVncUrl

The operation that you want to perform. Valid value: DescribeInstanceVncUrl.

Version string required Sample value: 2020-04-01

The version of the API. Valid value: 2020-04-01.

InstanceId string required Sample value: i-l8u10sauiu9qj0h*****

Instance ID

Response parameters

The table below lists only the response parameters specific to this operation. For more information, refer to response structure.

VncUrl string Sample value: wss://cn-beijing-a01-vncproxy-ecs.volcengine.com:443/websockify/destInfoToken/01495659-06ab-49ca-9aa7-d1b226*******

The URL of the management terminal.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	InvalidInstanceStatus	The status of the specified instance does not support this request.	The current status of the instance does not support this operation.
400	MissingParameter.InstanceId	The required parameter InstanceId is not supplied.	The instance ID cannot be left empty.
404	InvalidInstance.NotFound	The specified instance does not exist.	The specified instance does not exist.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service