查询一台轻量型云主机的Web管理终端地址
接口功能介绍
该接口提供用户查询一台轻量型云主机的Web管理终端地址。
获取到轻量型云主机访问地址如下所示：
http://203.193.231.250:60001/vnc_auto.html?token=f0b6ed3f-e049-4961-8c87-07815e058662&instance_name=VM-fbb407b6(aca51c6e-3c72-47ce-894e-1e2fbfdbabf9)
有如上信息后，在轻量型云主机为开机状态时，直接浏览器输入访问地址进行访问
接口约束
- 使用限制，本接口只支持在贵州3资源池进行公测
URI
GET /v4/ecs/lite/vnc/details
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以调用regionID查看最新的天翼云资源池列表 | 88f8888888dd88ec888888888d888d8b | |
| instanceID | 是 | String | 云主机ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| token | String | token | http://203.193.231.250:60001/vnc_auto.html?token=f0b6ed3f-e049-4961-8c87-07815e058662&instance_name=VM-fbb407b6(aca51c6e-3c72-47ce-894e-1e2fbfdbabf9) |
请求示例
GET .../v4/ecs/vnc/details?regionID=81f7728662dd11ec810800155d307d5b&instanceID=05221b32-99bc-1f0e-ae7d-feae50826a9d
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"token": "http://203.193.231.250:60001/vnc_auto.html?token=f0b6ed3f-e049-4961-8c87-07815e058662&instance_name=VM-fbb407b6(aca51c6e-3c72-47ce-894e-1e2fbfdbabf9)"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| LiteEcs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在，请确认资源池ID是否有效 |
| LiteEcs.RegionInfo.AccessFailed | 查询资源池失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.RegionInfo.DataDamaged | 查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.RegionVersion.NotSupport | 当前API不支持该资源池，请切换资源池重试 |
| Openapi.EcsWorkorder.AccessFailed | 查询云主机失败，请重试。如果多次尝试失败，请提交工单 |
| Openapi.EcsFormat.FormatError | 查询云主机信息格式错误，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Instance.NotFound | 云主机不存在，请确认云主机ID是否有效 |
| Openapi.EcsCheck.UnknownError | 云主机检查失败，请重试。如果多次尝试失败，请提交工单 |
