DescribeInstanceVncUrl

Description

When you call this operation, note that:

• A management terminal 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 management terminal connection is 60 seconds. If you do not interact with the management terminal within 60 seconds, the management terminal will be automatically disconnected.
• When the management terminal is disconnected, you can only reconnect to the management terminal up to 30 times a minute.
• At the end of https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.5/index.html?, add vncUrl=xxxx, instanceId=xxx, isWindows=True, isWindows=False, and password=XXXXXX. Connect these parameters with &. Where:
  • vncUrl: The value of VncUrl is returned after a successful query.
  • instanceId: the ID of instance to be queried.
  • isWindows: specifies whether the operating system of the instance is Windows. The value of true indicates the Windows system. The value of false indicates that the Windows system is not used.

  • password: Optional. The password to establish a remote connection from the instance. It must be six characters in length and can contain digits and uppercase and lowercase letters. This parameter eliminates the need to enter a password on the management terminal when a connection is being established.

    Example:

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

    or

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

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Response parameters

Examples

Sample requests

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

Sample success responses

XML format

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

JSON format

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

Error codes

View error codes