DescribeInstanceVncUrl

Description

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

• A VNC URL is only valid 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 VNC connection is 60 seconds. If you do not interact with the VNC within 60 seconds, the VNC will be automatically disconnected.
• When the VNC is disconnected, you can only reconnect to the VNC a maximum of 30 times a minute.
• You must set vncUrl to xxxx, instanceId to xxx, password to XXXXXX, and isWindows to True or isWindows to False at the end of the https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html? URL. Connect multiple parameters with ampersands (&). where:
  • vncUrl: the VncUrl value that is returned after a successful query.
  • instanceId: the ID of your instance.
  • isWindows: specifies whether the operating system of the instance is Windows. If the parameter is set to true, the operating system is Windows. If the value is set to false, the operating system is not Windows.

  • password: Optional. The password for connecting to the instance. It must be six characters in length and can contain digits and letters. You can use this parameter to eliminate the need to enter your password when you connect to the VNC.

    Examples:

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

    or

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

Request parameters

Response parameters

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeInstanceVncUrl
&InstanceId=i-bp1hzoinajzkh91h****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeInstanceVncUrlResponse>
      <RequestId>1450F2D7-5435-4420-BBC9-49C5xxxxxxxx</RequestId>
      <VncUrl>wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996</VncUrl>
</DescribeInstanceVncUrlResponse>

JSON format

{
    "RequestId": "1450F2D7-5435-4420-BBC9-49C5xxxxxxxx",
    "VncUrl": "wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996"
}

Error codes

For a list of error codes, visit the API Error Center.