接口功能介绍
获取物理机实例vnc地址
接口约束
无
URI
GET /v4/ebm/vnc
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 是 | String | 可用区名称或者 default。您可以调用 https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=25&api=5855&data=87 获取资源池信息，查询结果中zoneList内返回可用区名称，若查询结果中zoneList为空，即为单可用区，本字段填写default | az1 | |
| instanceUUID | 是 | String | 实例uuid | ss-eztbrc1j541lb2pim0lxr3uctdfo |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Ebm.Vnc.NotValid | |
| message | String | 响应结果的描述，一般为英文描述 | error request | |
| description | String | 响应结果的描述，一般为中文描述 | 错误请求 | |
| returnObj | Object | 返回参数，参考表returnObj | {} | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| endpoint | String | vnc的地址 | ws://192.168.0.1:60002 | |
| token | String | 连接vnc所需要的token | f2b88ea46033432e8f9ecab757e223f4 |
请求示例
Query
/v4/ebm/vnc?regionID=bb9fdb42056f11eda1610242ac110002&azName=az2&instanceUUID=ss-9d4u1yd1jr0a3xeu59fq9svecxql
响应示例
{
"statusCode": 800,
"returnObj": {
"endpoint": ws://192.168.0.1:60002,
"token": "f2b88ea46033432e8f9ecab757e223f4"
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Ebm.Vnc.NotValid | 请求参数非法 |
| Ebm.Vnc.NotFound | 物理机不存在 |
| Ebm.Common.CheckError | 内部错误，请重试 |
| 其他 | 参见公共错误码说明 |
访问方式
目前在控制台页面通过VNC页面远程登录云主机，是通过WebSocket协议进行访问，访问地址拼接如下所示：
wss://vnc.ctyun.cn/serial/bm/ + ${instance.azName} + /?token= + ${token} + &uuid= + ${instance.instanceUUID}
其中：
instance.azName为查询对应物理机结果返回的azName
token为请求vnc返回的token
instance.instanceUUID为查询对应物理机结果返回的instanceUUID有如上信息后，可在调用OpenAPI获取VNC token后拼接访问地址，使用xterm进行访问
