1)接口功能介绍
获取vnc链接。
2)接口约束
nodeCode边缘池id需要正确,可通过查看区域集群编码列表接口获取。
3)URI
GET /v1/getInstanceVncUrl。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码列表接口获取。 | cn-guangzhou3 | |
id | 是 | String | 虚拟机id | evm-xxx |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vncUrl | 是 | String | 返回的vnc链接 | wss://{host}/api/vnc/v1/accessVirtualMachineVnc?virtualMachineId=evm-cbqbkhf19r77rl5kthu0&token=NgUqaZcodXw4ERNPVmA51&nodeCode=hn-changde-1 |
6)请求示例
GET https://{host}/v1/getInstanceVncUrl?nodeCode=yn-lincang-1&id=evm-ce229jv19r78iu3nql30
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"vncUrl": "wss://{host}}/api/vnc/v1/accessVirtualMachineVnc?virtualMachineId=evm-ce229jv19r78iu3nql30&token=-G5lakv5f74HXsBbSwtsF&nodeCode=yn-lincang-1"
},
"requestId": "8597eb30-1399-4bf7-9ed1-71f2efcfe947"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |