Docs

Elastic Compute Service

Instances

DescribeInstanceECSTerminalUrl - Queries the ECS Terminal address of an ECS instance

Call the DescribeInstanceECSTerminalUrl operation to query the ECS Terminal address of an ECS instance.

Usage notes

You can also call DescribeInstanceVncUrl to obtain the VNC management terminal address of an ECS instance, and then use VNC to log in to the instance.

Compared with VNC, the ECS Terminal supports remote connections to the same instance by multiple operating system users, enables text copying and pasting, and allows visual browsing of system file resources. This makes the ECS Terminal more efficient and convenient than VNC. For more information, see Using the console to log in to a Linux instance.

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: DescribeInstanceECSTerminalUrl

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

Version string required Sample value: 2020-04-01

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

InstanceId string required Sample value: i-3tiefmkskq3vj0******

Instance ID

Response parameters

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

EcsTerminalUrl string Sample value: wss://cn-beijing-a01-vncproxy-ecs.volcengine.com:443/instance/login/18a948b9-00bd-4e56-b2a2-5de5f*******

The URL of the ECS 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.
404	InvalidPrimaryNetworkInterface.NotFound	The specified PrimaryNetworkInterface does not exist.	The specified primary network interface does not exist.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Last updated: 2026.04.17 10:57:28