接口功能介绍
查询一台云主机的Web管理终端地址。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
确认资源池类型：您可以查询资源池信息，查询结果中zoneList内，若返回存在可用区名称，则为多可用区类型资源池；若为空，则为非多可用区类型资源池
接口约束
云主机必须处于运行中(running)状态
获取访问地址与使用说明：
1.多可用区：
访问地址分几部分： WebSocket URL Prefix + ws? + token=xxxxxx + instanceId=uuid
WebSocket URL Prefix，即VNC的访问URL前缀，固定访问协议为wss，即使用HTTPS方式访问
有如上信息后，可在调用OpenAPI获取VNC token后拼接访问地址，使用noVNC等client进行访问，以noVNC为例，具体操作步骤如下：
* 本地启动noVNC服务，打开vnc页面；
* 点击左侧⚙，打开高级-WebSocket，在主机中，填写去掉wss协议后的地址：vm-vnc.ctyun.cn/vm_vnc/加密，端口写入443
* 点击右侧连接按钮，即可访问。
2.单可用区：
通过接口查到返回信息后，可直接浏览器输入访问地址进行访问
URI
GET /v4/ecs/vnc/details
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| token | String | token | wss://vm-vnc.ctyun.cn/vm_vnc/huadong1/az1/ws?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTU3NTY0NTQsImlhdCI6MTY5MjE1NjQ1NCwidXNlcl9pZCI6ImVhYWZlNWRjOWU1OWRlMmM3NmQwNmQwOGFlZTQ0YWZkIiwicHJvamVjdF9pZCI6ImFkOTFkMmNjMDUwY2M0YmIyMTVhZDc0ZDE1OGYzMGQxIiwiZG9tYWluX2lkIjoiZGVmYXVsdCIsInJvbGVzIjpbInVzZXIiXSwiY29uc3VtZXJfaWQiOiIiLCJpc3N1ZWRfYXQiOiIyMDIzLTA4LTE2VDAzOjI3OjM0LjAwMDAwMFoiLCJleHBpcmVfYXQiOiIyMDIzLTA5LTI2VDE5OjI3OjM0LjAwMDAwMFoiLCJNZXRob2QiOlsicGFzc3dvcmQiXX0.1cf3TcvzUfH5I7b4oBYK2yQ2g_ASUllpM5QtOMsWBB0&instanceId=df5e3e31-6cea-05a9-cbce-d74504328bef&instance_name=ecm-f856(df5e3e31-6cea-05a9-cbce-d74504328bef) |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1：多可用区华东1查询一台云主机的vnc地址
GET .../v4/ecs/vnc/details?regionID=bb9fdb42056f11eda1610242ac110002&instanceID=c5a7966a-88e7-362b-6e11-c2d8fbfc07ca
示例2：单可用区北京5查询一台云主机的vnc地址
GET .../v4/ecs/vnc/details?regionID=b6bb383e876c11ea8a5e0242ac110002&instanceID=ce2fa46e-5b30-471b-b6ef-f11f0908d5e9
响应示例
示例1：多可用区华东1查询一台云主机vnc地址
{
"returnObj": {
"token": "wss://vm-vnc.ctyun.cn/vm_vnc/huadong1/az1/ws?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTU3NTY0NTQsImlhdCI6MTY5MjE1NjQ1NCwidXNlcl9pZCI6ImVhYWZlNWRjOWU1OWRlMmM3NmQwNmQwOGFlZTQ0YWZkIiwicHJvamVjdF9pZCI6ImFkOTFkMmNjMDUwY2M0YmIyMTVhZDc0ZDE1OGYzMGQxIiwiZG9tYWluX2lkIjoiZGVmYXVsdCIsInJvbGVzIjpbInVzZXIiXSwiY29uc3VtZXJfaWQiOiIiLCJpc3N1ZWRfYXQiOiIyMDIzLTA4LTE2VDAzOjI3OjM0LjAwMDAwMFoiLCJleHBpcmVfYXQiOiIyMDIzLTA5LTI2VDE5OjI3OjM0LjAwMDAwMFoiLCJNZXRob2QiOlsicGFzc3dvcmQiXX0.1cf3TcvzUfH5I7b4oBYK2yQ2g_ASUllpM5QtOMsWBB0&instanceId=df5e3e31-6cea-05a9-cbce-d74504328bef&instance_name=ecm-f856(df5e3e31-6cea-05a9-cbce-d74504328bef)"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
示例2：单可用区北京5查询一台云主机vnc地址
{
"returnObj": {
"token": "http://49.7.114.250:60001/vnc_auto.html?token=7442618c-4167-4b9b-aa2d-016cd9414280&instance_name=ecm-90a3(ce2fa46e-5b30-471b-b6ef-f11f0908d5e9)"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
