All Products
Search
Document Center

Elastic Compute Service:DescribeInstanceVncUrl

Last Updated:Feb 04, 2024

Queries the Virtual Network Computing (VNC) URL of an Elastic Compute Service (ECS) instance.

Operation description

Description

When you call this operation, take note of the following items:

  • The URL returned is valid only for 15 seconds. If a connection is not established within 15 seconds after a successful query, the URL expires and you must query it again.

  • The KeepAlive time of a connection to a VNC management terminal is 60 seconds. If you do not interact with the VNC management terminal for 60 seconds, the VNC management terminal is automatically disconnected.

  • When you disconnect from the VNC management terminal, you can reconnect to the VNC management terminal up to 30 times a minute.

  • You must append the following parameters to the end of the https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html? URL: vncUrl, instanceId, isWindows (True or False), and password. Connect these parameters with ampersands (&).

    • vncUrl: the VncUrl value returned after a successful query.

    • instanceId: the ID of your instance.

    • isWindows: specifies whether the operating system of the instance is Windows. Set the parameter to true if the operating system is Windows. Set the parameter to false if the operating system is not Windows.

    • password: Optional. A six-character password used to connect to the VNC management terminal. It can contain digits and letters. You do not need to enter your password again when the connection is being established if you set this parameter.

      Example:

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

      Or:

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. You can call the DescribeRegions operation to query the most recent list of regions.

cn-hangzhou
InstanceIdstringYes

The ID of the instance

i-bp1hzoinajzkh91h****

Response parameters

ParameterTypeDescriptionExample
object
VncUrlstring

The URL of the VNC management terminal.

wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidRegionInstanceThe specified InstanceId does not exist in given region.The instance does not exist in the specified region.
403IncorrectInstanceStatusThe current status of the resource does not support this operation.The resource is in a state that does not support the current operation.
403InstanceNotReadyThe specified instance is not ready for useThe specified instance is not available. Check to see if the instance status is preventing this action and try again later.
403InstanceNotReadyTemporarily unable to connect the specified instance,please try later.-
404InvalidRegionId.NotFoundThe specified RegionId does not exist.The specified region ID does not exist.
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.The specified instance does not exist.
500InternalErrorThe 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.