文档首页> 弹性云服务器 ECS> API参考> API（OpenStack Nova 原生）> 云服务器控制台管理> 获取VNC远程登录地址（微版本2.6及以上）
更新时间：2023-07-06 GMT+08:00
前往Github编辑
查看PDF
分享

获取VNC远程登录地址（微版本2.6及以上）

功能介绍

获取弹性云服务器VNC远程登录地址。

URI

POST /v2.1/{project_id}/servers/{server_id}/remote-consoles

参数说明请参见表1。
表1 参数说明

参数

是否必选

描述

project_id

是

项目ID。

获取方法请参见获取项目ID。

server_id

是

弹性云服务器ID。

接口约束

  • 使用此接口时，请指定微版本不低于2.6。

    "微版本号": 通过Http请求头X-OpenStack-Nova-API-Version来或者OpenStack-API-Version添加。

    示例：X-OpenStack-Nova-API-Version：2.6 或者OpenStack-API-Version：compute 2.6

  • 获取的登录地址有效时间10min，超过10min请重新获取。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

remote_console

是

Object

弹性云服务器获取VNC远程登录地址，参考表3。
表3 remote_console参数信息

参数

是否必选

参数类型

描述

type

是

String

远程登录的类型，请将type配置为“novnc”。

protocol

是

String

远程登录协议，请将protocol配置为“vnc”。

响应消息

响应参数如表4所示。

表4 响应参数

参数

参数类型

描述

remote_console

Object

弹性云服务器获取远程登录地址，参考表5。
表5 remote_console参数信息

参数

参数类型

描述

type

String

远程登录的类型。

protocol

String

远程登录的协议。

url

String

远程登录的url。

该url有效时间10min，超过10min请重新获取。

请求示例

获取指定云服务器的VNC远程登录地址。

POST https://{endpoint}/v2.1/13c67a214ced4afb88d911ae4bd5721a/servers/47bc79ae-df61-4ade-9197-283a74e5d70e/remote-consoles

{
   "remote_console" : {
        "type" : "novnc",
        "protocol": "vnc"
    }
}

响应示例

{
	"remote_console": {
		"url": "https://nova-novncproxy.az21.dc1.domainname.com:8002/vnc.auto.html?token=80fa7c8d-37fe-451e-8b08-bfbd9fb6a4df&lang=EN",
		"type": "novnc",
		"protocol": "vnc"
	}
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

分享：

    相关文档

    相关产品