You need to enable JavaScript to run this app.
文档中心
云手机

云手机

复制全文
下载 pdf
可观测接口
创建 noVNC 拉流会话 CreateCuaNodeNoVNCSession
复制全文
下载 pdf
创建 noVNC 拉流会话 CreateCuaNodeNoVNCSession
noVNC 是一个基于浏览器的 VNC 客户端,无需安装任何客户端,通过浏览器即可实时查看和操作远程设备的桌面画面。​
调用本接口可获取指定节点的 noVNC 会话链接,用于在浏览器中查看设备画面。​
使用说明​
调用 CUA OpenAPI 前,必须先访问 跨服务访问请求 为您的账号授权。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://open.volcengineapi.com?Action=CreateCuaNodeNoVNCSession&Version=2023-08-01​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见 公共参数。​
Header​
​
参数​
类型​
是否必选​
示例值​
描述​
Content-Type​
String​
是​
application/json​
请求头信息。​
​
Query​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
CreateCuaNodeNoVNCSession​
接口名称。当前 API 的名称为 CreateCuaNodeNoVNCSession。​
Version​
String​
是​
2023-08-01​
接口版本。当前 API 的版本为 2023-08-01。​
​
Body​
​
参数​
类型​
是否必选​
示例值​
描述​
Id​
Integer​
否​
123​
节点 ID。​
说明​
本参数与 Ecsid 二选一必填。​
Ecsid​
String​
否​
i-yep01nszy84c5qw*****​
节点对应的 ECS 实例 ID。​
说明​
本参数与 Id 二选一必填。​
​
返回参数​
下表仅列出本接口特有的返回参数。更多信息请见 返回结构。​
​
参数​
类型​
示例值​
描述​
ViewerUrl​
String​
https://agent.example.com:8911/novnc/view?sid=sid-123​
可视化页面的访问地址。​
说明​
通过任意浏览器直接打开该地址,即可查看设备画面。​
WebsocketUrl​
String​
wss://agent.example.com:8911/novnc/ws?sid=sid-123​
WebSocket 连接地址。​
说明​
用于程序接入时建立 WebSocket 连接,实现实时数据传输。​
HttpViewerUrl​
String​
http://agent.example.com:8910/novnc/view?sid=sid-123​
noVNC 页面的 HTTP 访问地址。适用于无需 TLS 加密的内网访问或调试场景。​
WsWebsocketUrl​
String​
ws://agent.example.com:8910/novnc/ws?sid=sid-123​
noVNC 的 WebSocket 连接地址。适用于无需 TLS 加密的内网访问或调试场景。​
ExpiresAt​
Integer​
1781599999​
链接的过期时间,格式为 Unix 时间戳(秒)。超过该时间后,链接将失效。​
​
请求示例​
​
POST https://open.volcengineapi.com?Action=CreateCuaNodeNoVNCSession&Version=2023-08-01​
{​
"Id": 123,​
"Ecsid": "i-yep01nszy84c5qw*****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "CreateCuaNodeNoVNCSession",​
"Version": "2024-01-01",​
"Service": "cua",​
"Region": "cn-beijing"​
},​
"Result": {​
"ViewerUrl": "https://agent.example.com:8911/novnc/view?sid=sid-123",​
"WebsocketUrl": "wss://agent.example.com:8911/novnc/ws?sid=sid-123",​
"ExpiresAt": 1710000000,​
"HttpViewerUrl": "http://agent.example.com:8910/novnc/view?sid=sid-123",​
"WsWebsocketUrl": "ws://agent.example.com:8910/novnc/ws?sid=sid-123"​
}​
}​
​
错误码​
CUA OpenAPI 错误码请参见 错误码。​
​
最近更新时间:2026.09.30 11:04:49
这个页面对您有帮助吗?
有用
有用
无用
无用