查询一台云主机的Web管理终端地址
接口功能介绍
查询一台云主机的Web管理终端地址。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
确认资源池类型:您可以查询资源池信息,查询结果中zoneList内,若返回存在可用区名称,则为多可用区类型资源池;若为空,则为非多可用区类型资源池
获取访问地址与使用:
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)
访问地址分几部分:
<WebSocket URL Prefix>
+ws?
+token=<token>
+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/<region name>/<az name>/ws?instanceId=<uuid>&token=<token>
,选中加密
,端口写入443
- 点击右侧连接按钮,即可访问。
单可用区:
http://55.7.114.250:60001/vnc_auto.html?token=9b661818-f700-4c33-8ada-94cfe0b9a528&instance_name=ctapi-new-1(1edcf309-4128-4db4-a0b5-99b0240ac27d)
查到信息后,可直接浏览器输入访问地址进行访问
接口约束
云主机需要处于开机状态(running),您可以调用查询一台云主机详细信息或获取多台云主机的状态信息查询结果中的instanceStatus字段来确认当前云主机状态
URI
GET /v4/ecs/vnc/details
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
instanceID | 是 | String | 云主机ID,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表创 创建一台按量付费或包年包月的云主机创 批量创建按量付费或包年包月云主机 |
9a1fdc59-b6a2-32bb-780f-3b00653c56f7 |
请求参数
请求头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) |
请求示例
示例:华东1查询1台云主机的vnc地址
GET .../v4/ecs/vnc/details?regionID=bb9fdb42056f11eda1610242ac110002&instanceID=c5a7966a-88e7-362b-6e11-c2d8fbfc07ca
请求头header
无
请求体body
无
响应示例
{
"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
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
错误码 | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.NotFound | 未找到对应云主机,请确认云主机ID是否正确 |
Ecs.Instance.StatusNotValid | 云主机状态无效,请确认云主机状态是否符合操作条件 |
Openapi.EcsCheck.UnknownError | 云主机检查失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsFormat.FormatError | 查询云主机信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsWorkorder.AccessFailed | 查询云主机信息失败,请重试。如果多次尝试失败,请提交工单 |