接口功能介绍
该接口提供用户查询一台轻量型云主机的Web管理终端地址。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
获取到轻量型云主机访问地址如下所示：http://203.193.231.250:60001/vnc_auto.html?token=f0b6ed3f-e049-4961-8c87-07815e058662&instance_name=VM-fbb407b6(aca51c6e-3c72-47ce-894e-1e2fbfdbabf9)有如上信息后，在轻量型云主机为开机状态时，直接浏览器输入访问地址进行访问
接口约束
1. 使用限制，本接口只支持在部分资源池进行公测
1. 确保当前请求资源池下，该云主机存在且处于开机状态（running），您可以调用查询一台云主机详细信息或获取多台云主机的状态信息查询结果中的instanceStatus字段来确认当前云主机状态
URI
GET /v4/ecs/lite/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 | http://203.193.231.250/vnc_auto.html?token=f0b6ed3f-e049-4961-8c87-07815e058662&instance_name=VM-fbb407b6(aca51c6e-3c72-47ce-894e-1e2fbfdbabf9) |
枚举参数
无
请求示例
请求url
GET .../v4/ecs/vnc/details?regionID=aaf589124d5d11eaa04d0242ac110002&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
}
状态码
请参考 状态码
错误码
请参考 错误码
