获取云服务器VNC地址及登录信息
1. 接口描述
调用 DescribeInstanceVncInfo 接口查询一台实例的 VNC 登录地址及相关登录信息。
仅支持对已有实例查询其 VNC 信息。
请确保调用方已具备访问该实例的权限。
接口返回的是VNC连接所需的Token信息，您需要使用此Token来建立Web管理终端连接。
WebSocket连接地址为： wss://vnc.kaopuyun.com/vncHost?token=VncToken
请注意：
此地址是一个WebSocket服务地址，您需要集成了VNC客户端的页面中使用，不可直接在浏览器地址栏中访问。
获取到的Token有效期为300秒。请在有效期内发起VNC连接，否则Token将自动失效。
2. 请求参数
| 参数名 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| Action | String | 是 | 固定取值：DescribeInstanceVncInfo |
| EcsInstanceUuid | String | 是 | 实例ID |
3. 返回数据
| 参数名 | 类型 | 说明 |
|---|---|---|
| RegionCode | String | 实例所属的地域编码 |
| VncHost | String | VNC 登录地址 |
| VncPort | Integer | VNC 登录端口 |
| VncPassword | String | 登录密码 |
| VncToken | String | 登录 Token |
| RequestId | String | 请求ID |
4. 示例
请求示例
https://openapi.kaopuyun.com/?SignatureVersion=1.0
&AccessKeyId=5OyWnDx2M4VJ
&Action=DescribeInstanceVncInfo
&EcsInstanceUuid=ecs-8200000xouqs
&Format=JSON
&SignatureMethod=HMAC-SHA1
&SignatureNonce=b6da29f3-2921-4be7-a7f5-cd3c9f38510d
&SignatureVersion=1.0
&Timestamp=2025-11-06T01%3A42%3A10Z
&Version=2014-05-26
&Signature=quY8LpUGyqRbujnOKYJNfFNMJTU%3D
正常返回示例
{
"VncHost": "vnc-console-dev.kaopuvm.com",
"RegionCode": "cn-dev-1",
"RequestId": "3a985720-bab3-11f0-a5f0-a212610cebb0",
"VncToken": "kyp9IUqnGWNxY9t3GSBwmkh8jJ7IvJ7b",
"VncPort": "6080",
"VncPassword": "OC00YjA0LTgyYzQtZjk1"
}
5. 错误码
| 错误码 | 错误信息 |
|---|---|
| AvailableInstanceNotFound | 可用实例未找到 |
| NoPermission | 没有权限 |
| IncorrectInstanceStatus | 实例状态不正确 |
| EcsInstanceVncError | 实例VNC获取失败 |
| GetVncInfoFail | 获取VNC信息失败：xxx |