You need to enable JavaScript to run this app.
导航
DescribeInstanceVncUrl - 查询VNC管理终端地址
最近更新时间:2024.10.28 17:36:25首次发布时间: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秒内没有任何交互操作时,连接自动断开。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

DescribeInstanceVncUrl

要执行的操作,取值:DescribeInstanceVncUrl。

Version
String

2020-04-01

API的版本,取值:2020-04-01。

InstanceId
String

i-l8u10sauiu9qj0h*****

实例ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
VncUrl
String

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*******"
        }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidInstanceStatus
The status of the specified instance does not support this request.

当前实例的状态不支持此操作。

400
MissingParameter.InstanceId
The required parameter InstanceId is not supplied.

参数实例ID不能为空。

404
InvalidInstance.NotFound
The specified instance does not exist.

指定的实例不存在。

500
InternalError
An internal error has occurred.

内部错误,请重试。如果多次尝试失败,请提交工单。