查询实例管理终端地址

最近更新时间:2024-03-12 01:38:01

我的收藏

1. 接口描述

接口请求域名: lighthouse.tencentcloudapi.com 。

本接口 ( DescribeInstanceVncUrl ) 用于查询实例管理终端地址,获取的地址可用于实例的 VNC 登录。

  • 处于 STOPPED 状态的机器无法使用此功能。
  • 管理终端地址的有效期为 15 秒,调用接口成功后如果 15 秒内不使用该链接进行访问,管理终端地址自动失效,您需要重新查询。
  • 管理终端地址一旦被访问,将自动失效,您需要重新查询。
  • 如果连接断开,每分钟内重新连接的次数不能超过 30 次。
  • 参数 InstanceVncUrl :调用接口成功后会返回的 InstanceVncUrl 的值。
    获取到 InstanceVncUrl 后,您需要在链接 https://img.qcloud.com/qcloud/app/active_vnc/index.html? 末尾加上参数 InstanceVncUrl=xxxx
    最后组成的 URL 格式如下:

https://img.qcloud.com/qcloud/app/active_vnc/index.html?InstanceVncUrl=wss%3A%2F%2Fbjvnc.qcloud.com%3A26789%2Fvnc%3Fs%3DaHpjWnRVMFNhYmxKdDM5MjRHNlVTSVQwajNUSW0wb2tBbmFtREFCTmFrcy8vUUNPMG0wSHZNOUUxRm5PMmUzWmFDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9

默认接口请求频率限制:10次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceVncUrl。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID。可通过DescribeInstances接口返回值中的InstanceId获取。
示例值:lhins-ruy9d2tw

3. 输出参数

参数名称 类型 描述
InstanceVncUrl String 实例的管理终端地址。
示例值:wss%3A%2F%2Fusevnc.qcloud.com%3A443%2Fvnc%3Fs%3D
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例管理终端地址

本示例用于查询实例管理终端地址。

输入示例

POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceVncUrl
<公共请求参数>

{
    "InstanceId": "lhins-ruy9d2tw"
}

输出示例

{
    "Response": {
        "InstanceVncUrl": "wss%3A%2F%2Fusevnc.qcloud.com%3A443%2Fvnc%3Fs%3DTnVQUEpVYkc4eUMvMEkyUERKUjhRbzJhbGcyWHFaWmVMU1dRbUQwd0hVVHo2WU4wOEpLWjlQd0JVSWQwUXZOK2FDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9%26password%3D%26isWindows%3Dfalse%26isUbuntu%3Dfalse",
        "RequestId": "f9f6fa33-679c-40ea-bb30-b1e9a8989305"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.DescribeInstanceStatus 查询实例状态错误。
FailedOperation.InstanceOperationFailed 对实例的操作失败。
InternalError.DescribeInstanceStatus 查询实例状态失败,请稍后重试。
InternalError.InvalidCommandNotFound 命令无法找到。
InvalidParameterValue.InstanceIdMalformed 参数值非法,实例 ID 格式非法。
OperationDenied.InstanceCreating 禁止对实例进行操作,实例在创建中,不允许进行该操作。
ResourceNotFound.InstanceIdNotFound 实例 ID 不存在。
ResourceNotFound.InstanceNotFound 实例不存在。
UnauthorizedOperation.NoPermission 无权限。
UnsupportedOperation.InvalidInstanceState 不支持的操作,实例状态不合法。
UnsupportedOperation.LatestOperationUnfinished 不支持的操作,实例最近一次的操作尚未完成。