Call the DescribeInstanceVncUrl API to query the VNC logon address - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Operation description

The API returns a VNC logon URL (VncUrl) that cannot be used directly. You can access the instance through the management terminal URL.

Note

To construct the management terminal URL, append vncUrl=\*\*\*\*, instanceId=****, and isWindows=true/false to the end of https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?, and connect the parameters with &. Parameters:

vncUrl: the VNC logon URL.
instanceId: the instance ID.
isWindows: specifies whether the operating system of the instance is Windows. A value of true indicates Windows. A value of false indicates non-Windows.
Password-free VNC connections are supported. You do not need to set the password parameter.

The KeepAlive time of a single management terminal URL is 300 seconds. If no interaction occurs within 300 seconds, the connection is automatically closed.
If the connection is interrupted, call this operation again to obtain a new VncUrl and construct a new management terminal URL to reconnect. You can reconnect up to 30 times per minute.

Example management terminal URL:

https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true
```.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeInstanceVncUrl

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
InstanceId	string	Yes	The instance ID.	i-bp1hzoinajzkh91h****

Response elements

Element	Type	Description	Example
	object
VncUrl	string	The VNC logon URL. Important The VNC logon URL is time-sensitive and valid for 15 seconds. If you do not use the URL within 15 seconds after a successful call, the URL expires and you must call this operation again to obtain a new one. .	wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "VncUrl": "wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidRegionInstance	The specified InstanceId does not exist in given region.	The instance does not exist in the specified region.
500	InternalError	The request processing has failed due to some unknown error.
403	IncorrectInstanceStatus	The current status of the resource does not support this operation.
403	InstanceNotReady	The specified instance is not ready for use
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	The specified region ID does not exist.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instanceId is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.