查询一台云手机实例的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:ListInstanceVncUrl | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 云手机实例所属地域 | cn-hangzhou |
| InstanceId | string | 是 | 云手机实例 ID | cp-xxxxxxxx |
返回参数
示例
正常返回示例
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-22 | OpenAPI 入参发生变更 | 看变更集 | ||||
|