本接口用于查询一台ECS实例的VNC登录地址。
接口说明
- 接口返回的是 VNC 登录地址（VncUrl），不能直接使用访问，您可以通过 Web 管理终端地址访问。
说明
Web 管理终端地址需在链接当前已支持免 VNC 密码连接实例，您无需设置参数
https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?末尾加上vncUrl=\*\*\*\*、instanceId=****和isWindows=true/false，参数之间使用&连接。其中：
vncUrl：VNC 登录地址。instanceId：实例 ID。isWindows：实例的操作系统是否为 Windows 系统。取值为true表示是 Windows 系统，取值为false表示不是 Windows 系统。password。- 单个管理终端链接地址的 KeepAlive 时间为 300 秒，300 秒内您与管理终端窗口没有任何交互操作时，连接自动断开。
- 如果连接中断，您需要重新调用接口来获取新的
VncUrl，以组成新的管理终端地址进行重新连接，且每分钟内重新连接的次数不能超过 30 次。
Web 管理终端地址示例：
https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:DescribeInstanceVncUrl | get | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| InstanceId | string | 是 | 实例 ID。 | i-bp1hzoinajzkh91h**** |
返回参数
示例
正常返回示例
JSON格式
{
"VncUrl": "wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidRegionInstance | The specified InstanceId does not exist in given region. | 该实例在指定的地域中不存在，请确认参数是否正确。 |
| 403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | 该资源目前的状态不支持此操作。 |
| 403 | InstanceNotReady | The specified instance is not ready for use | 暂时无法连接指定的实例，请稍后再试。 |
| 403 | InstanceNotReady | Temporarily unable to connect the specified instance,please try later. | - |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定的地域 ID 不存在。 |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的实例ID未找到。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 内部错误，请重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史