首页 弹性云手机 API参考指南 API目录 实例 ListInstanceVncUrl - 获取实例VNC登录链接

ListInstanceVncUrl - 获取实例VNC登录链接

调用ListInstanceVncUrl查询一台云手机实例的Web管理终端地址。

接口说明

调用该接口时,您需要注意:

  • 管理终端地址的有效期为15秒,调用接口成功后如果15秒内不使用该链接,URL地址自动失效,您需要重新查询。
  • 单个管理终端链接的持久链接(KeepAlive)时间为60秒,60秒内您管理终端窗口没有任何交互操作时,连接自动断开。
  • 如果连接中断,每分钟内重新连接的次数不能超过30次。
  • 您需要在链接https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?末尾加上vncUrl=****、instanceId=****和password=****,参数之间使用&连接。其中:
    • 参数vncUrl:调用接口成功后会返回的VncUrl的值。
    • 参数instanceId:您的实例ID。
    • (可选)参数password:该实例的远程连接密码,由六位数字或大小写字母组成。使用该参数时,在连接管理终端处您不需要再输入密码。

请求示例如下:

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

或者:

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cloudphone:ListInstanceVncUrlRead
  • ECP
    acs:cloudphone:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

云手机实例所属地域

cn-hangzhou
InstanceIdstring

云手机实例ID

cp-xxxxxxxx

返回参数

名称类型描述示例值
object
VncUrlstring

VNC登录链接。

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

请求ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
WebRtcTokenstring

WebRTC登录使用的Token。

D3EC1DE8C12E******

示例

请求示例

http(s)://[Endpoint]/?Action=ListInstanceVncUrl
&InstanceId=cp-xxxxxxxx
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2021-12-22OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:ShowWebRtcToken
阿里云首页 弹性云手机 相关技术圈