You need to enable JavaScript to run this app.
导航

DescribeInstanceVncUrl

最近更新时间2023.11.20 10:48:34

首次发布时间2021.12.29 11:18:50

调用 DescribeInstanceVncUrl 查询一台云服务器的VNC管理终端地址。

接口说明

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

  • 无法使用ECS Terminal连接Linux实例时,您可以通过控制台的 VNC远程连接 登录实例,查看云服务器操作界面的实时状态。

  • 您可以按以下操作生成VNC登录链接(JS格式):
    https://console.volcengine.com/ecs/connect/vnc/?末尾增加Region=****host=****name=****,参数之间使用&连接。

    名称描述示例值
    Region实例所在地域。cn-beijing
    host调用 DescribeInstanceVncUrl 接口返回的VncUrl的值。cn-beijing-a01-vncproxy-ecs.volcengine.com:443/websockify/destInfoToken/01495659-06ab-49ca-9aa7-d1b226*******
    name实例名称。instance-host-name

    示例如下(JS格式):

    https://console.volcengine.com/ecs/connect/vnc/?Region=cn-beijing&host=cn-beijing-a01-vncproxy-ecs.volcengine.com:443/websockify/destInfoToken/01495659-06ab-49ca-9aa7-d1b226*******&name=instance-host-name
    
  • VNC登录成功后,您的管理终端窗口在180秒内没有任何交互操作时,连接自动断开。

调试

请求参数

名称类型是否必选示例值
描述
ActionStringDescribeInstanceVncUrl要执行的操作,取值:DescribeInstanceVncUrl。
VersionString2020-04-01API的版本,取值:2020-04-01。
InstanceIdStringi-l8u10sauiu9qj0h*****实例ID。

返回数据

名称类型示例值描述
VncUrlString
wss://cn-beijing-a01-vncproxy-ecs.volcengine.com:443/websockify/destInfoToken/01495659-06ab-49ca-9aa7-d1b226*******
管理终端Url。

请求示例

GET /?Action=DescribeInstanceVncUrl&Version=2020-04-01&InstanceId=i-l8u10sauiu9qj0h***** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
        "ResponseMetadata": {
                "RequestId": "20211104180426010194099035220C****",
                "Action": "DescribeInstanceVncUrl",
                "Version": "2020-04-01",
                "Service": "ecs",
                "Region": "cn-beijing"
        },
        "Result": {
                "VncUrl": "wss://cn-beijing-a01-vncproxy-ecs.volcengine.com:443/websockify/destInfoToken/01495659-06ab-49ca-9aa7-d1b226*******"
        }
}

错误码

HttpCode错误码错误信息描述
400MissingParameter.InstanceIdThe required parameter InstanceId is not supplied.实例ID不能为空。
400InvalidInstanceStatusThe status of the specified instance does not support this request.当前实例的状态不支持此操作。
404InvalidInstance.NotFoundThe specified instance does not exist.指定的实例不存在。
500InternalErrorAn internal error has occurred.内部错误,请重试。如果多次尝试失败,请提交工单。