DescribeInstanceVncUrl - 云服务器 ECS

接口说明

调用该接口时，您需要注意：

管理终端地址的有效期为15秒，调用接口成功后如果15秒内不使用该链接，URL地址自动失效，您需要重新查询。
单个管理终端链接的持久链接（KeepAlive）时间为60秒，60秒内您管理终端窗口没有任何交互操作时，连接自动断开。
如果连接中断，每分钟内重新连接的次数不能超过30次。
您需要在链接https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?末尾加上vncUrl=****、instanceId=****、isWindows=True/False和password=****，参数之间使用&连接。其中：
- 参数vncUrl：调用接口成功后会返回的VncUrl的值。
- 参数instanceId：您的实例ID。
- 参数isWindows：该实例的操作系统是否是Windows系统。取值为true表示是Windows系统，取值为false表示不是Windows系统。
- （可选）参数password：该实例的远程连接密码，由六位数字或大小写字母组成。使用该参数时，在连接管理终端处您不需要再输入密码。
  
  请求示例如下：
```
https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true
        
```
  或者：
```
https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true&password=****
       
```

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeInstanceVncUrl	系统规定参数。取值：DescribeInstanceVncUrl。
RegionId	String	是	cn-hangzhou	实例所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
InstanceId	String	是	i-bp1hzoinajzkh91h****	实例ID。

返回数据

名称	类型	示例值	描述
VncUrl	String	wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996	管理终端Url。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	请求ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeInstanceVncUrl
&InstanceId=i-bp1hzoinajzkh91h****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceVncUrlResponse>
    <VncUrl>wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996</VncUrl>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</DescribeInstanceVncUrlResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode	错误码	错误信息	描述
400	InvalidRegionInstance	The specified InstanceId does not exist in given 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.	指定的地域 ID 不存在。
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	指定的实例不存在，请您检查实例ID是否正确。

访问错误中心查看更多错误码。