Queries the Virtual Network Computing (VNC) logon address of an Elastic Compute Service (ECS) instance.
Operation description
Usage notes
Take note of the following items:
-
The keepalive time of a connection to a VNC management terminal is 300 seconds. If you do not interact with the VNC management terminal for 300 seconds, the VNC management terminal is automatically disconnected.
-
If the connection is interrupted, you must recall this operation to obtain a new logon address that is specified by
VncUrl
and use the new logon address to construct a URL that can be used to reconnect to the VNC management terminal. You can reconnect to a VNC management terminal for a maximum of 30 times per minute. -
You need to add the
vncUrl=\*\*\*\*
,instanceId=\*\*\*\*
, andisWindows=true/false
parameters to the end of the linkhttps://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?
and use an ampersand (&
) between the parameters.vncUrl
: the value ofVncUrl
that is returned after a successful call of this operation.instanceId
: the ID of your instance.isWindows
: specifies whether the operating system of your instance is Windows. A value oftrue
indicates that the operating system is Windows. A value offalse
indicates that the operating system is not Windows.
password
parameter.
Sample URL:
https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the instance. You can call the DescribeRegions operation to query the most recent list of regions. | cn-hangzhou |
InstanceId | string | Yes | The ID of the instance | i-bp1hzoinajzkh91h**** |
Response parameters
Examples
Sample success responses
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. |
403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | The resource is in a state that does not support the current operation. |
403 | InstanceNotReady | The specified instance is not ready for use | The specified instance is not available. Check to see if the instance status is preventing this action and try again later. |
403 | InstanceNotReady | Temporarily unable to connect the specified instance,please try later. | - |
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 instance does not exist. |
500 | InternalError | The request processing has failed due to some unknown error. | An internal error has occurred. Try again later. |
For a list of error codes, visit the Service error codes.