DescribeInstanceVncUrl
本接口用于查询一台ECS实例的VNC登录地址
服务地址:
华东1 金融云
输入参数
只看必填
RegionId实例所属的地域ID
InstanceId实例ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 接口返回的是 VNC 登录地址(VncUrl),不能直接使用访问,您可以通过 Web 管理终端地址访问。
说明 Web 管理终端地址需在链接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 系统。
  • 当前已支持免 VNC 密码连接实例,您无需设置参数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
    

    请求参数

    字段名称字段详情
    RegionIdstring

    实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

    示例值:cn-hangzhou参考取值来源:
      DescribeRegions
    InstanceIdstring

    实例 ID。

    示例值:i-bp1hzoinajzkh91h****参考取值来源:
      RunInstances
      StopInstances
      CreateInstance
      StartInstances
      RebootInstances
      DescribeInstances
      ModifyManagedInstance
      RenewReservedInstances
      DetachInstanceRamRole
      AttachInstanceRamRole
      DeregisterManagedInstance
      PurchaseReservedInstancesOffering

    返回参数

    字段名称字段详情
    VncUrlstring

    VNC 登录地址。展开详情

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

    请求 ID。

    示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    变更历史
    暂无变更历史