3.2 接口文档
获取凭证的签名
1. 第三方接口开发说明
1.1.1 基础版接口说明
1.1.2 开发版接口说明
1.2基础版接口
1.2.1 获取开放的应用列表
1.2.2 进入应用
1.2.3 获取进入应用URL
1.2.4 获取请求附加参数
1.2.5 获取区域信息
1.2.6 生成roomCode-authCode
1.2.7 获取运行数
1.3开发版接口-应用管理
1.3.1 查询应用一览
1.3.2 上传应用程序包接口
1.3.3 上传课程封面图接口
1.3.4 创建应用
1.3.5 修改应用
1.3.6 更新应用上-下架状态
1.3.7 删除应用
1.3.8 后台启动VR应用
1.3.9 后台关闭VR应用
1.3.10 批量停止正在运行的应用
1.3.11 获取运行应用一览
1.3.12 获取已结束进程一览
1.4开发版接口-预启动应用
1.4.1 查询预启动应用一览
1.4.2 创建预启动应用接口
1.4.3 更新预启动应用接口
1.4.4 删除预启动应用接口
1.5开发版接口-Task管理
1.5.1 获取指定Task信息
1.5.2 获取使用次数最高的10个应用
1.5.3获取使用时长最高的10个应用
1.5.4按省统计应用使用情况
1.5.5按某个省统计各市使用情况
1.5.6统计其他使用情况
1.5.7统计总使用次数
1.5.8统计总使用时长
1.5.9统计当日使用次数
1.5.10统计当日使用时长
1.6开发版接口-节点管理
1.6.1渲染节点查询(分页
1.7开发版接口--VR管理
1.7.1客户端查询(分页)
1.7.2获取VR客户端资源使用情况
1.7.3VR客户端监控页面
1.8开发版接口-分组管理
1.8.1 分组查询
1.8.2添加组别
1.8.3修改组别
1.8.4删除组别
1.8.5设置组别的运行模式
1.8.6 获取组别的运行模式
1.8.7渲染服务器绑定组别
1.8.8组别批量绑定服务器
1.8.9渲染服务器解绑定组别
1.8.10组别批量解绑定服务器
1.8.11通过服务器ID和组别ID解绑定渲染服务器组别
1.9开发版接口-接入管理
1.9.1接入管理一览(分页)
1.9.2添加接入凭证
1.9.3更新接入管理
1.9.4删除接入管理
1.9.5更新接入后台密钥
1.9.6创建客户端凭证密钥
1.9.7清除客户端凭证密钥
1.10开发版接口-其他
1.10.1获取系统名称
1.10.2获取系统版本号
1.10.3获取眼镜客户端资源监控数据
1.10.4获取服务端资源监控数据
1.10.5 远程桌面连接
1.11开发版接口-参数设置
1.11.1参数设置查询
1.11.2无操作时限-查询
1.11.3无操作超时-更新
1.11.4存储-查询
1.11.5应用存储类型存储-更新
1.11.6是否保存VR监控数据-更新
1.11.7VR监控数据保存期限-更新
1.11.8VR是否保存服务器资源使用率数据-更新
1.11.9是否开启应用一览页面-查询
1.11.10是否开启应用一览页面-保存
1.11.11 IP黑白名单-查询
1.11.12 IP黑白名单-新增
1.11.13 IP黑白名单-删除
1.11.14 端口映射-查询
1.11.15 端口映射-新增
1.11.16 端口映射-更新
1.11.17 端口映射-删除
1.11.18 定制免费版Logo-查询
1.11.19 定制免费版Logo-更新
1.11.20 免费版Logo-清除
1.11.21免费版Logo圆盘-保存
2.code对照
code对照
3.后台功能
3.1接入管理
-
+
首页
1.5.1 获取指定Task信息
**1.5.1 获取指定Task信息** | 请求方式 | GET | | ------------ | ------------ | | **请求URL** | http: // {LarkXR3.2管理服务器IP}:8181/taskInfo/getTask | **升级说明** - 默认端口由8282变为8181 - 应用类型由“appType”变更为“appliType”,值由【1:独占GPU、2:共享GPU、3:VR(SteamVR)、4:VR(OpenXR) 、5:AR】变更为【1:独占GPU、2:共享GPU、3:VR(SteamVR)、5:VR(SteamVR:依赖Steam)、6:VR(Nvidia)、7:VR(OpenXR)【开发中】、9:AR(PXY)【开发中】 、 - - - AR(Nvidia)】 - Task状态由taskStatus变更为status - 去除删除标识deleteFlag - 去除是否使用口令useRoomCode - 增加预启动标识 reserveFlag,0:不使用预启动,1:使用预启动 - 3.2.21版本开始,参数"roomCode"字段,变更为"authCode" ``` 参考样例 :http://192.168.1.11:8181/taskInfo/getTask ``` |名称 | 类型 | 是否必须 |描述| | ------------ | ------------ | ------------ |------------ | | taskId | Long | 是 |应用ID<br/>来源:<br/>1:/appli/getStartURL接口中返回值url包含taskId这个参数<br/>2:当应用在后台设置了传递TaskId,应用启动后,能够从命令行参数中获取到进入应用时分配的taskId| 返回结果: |名称 | 类型 | 是否必须 | 描述 | | ------------ | ------------ | ------------ | ------------ | |code | Integer | 是 | 返回状态 | |message | String | 否 |返回消息 | | result | String | 否 | Code=1000的时候,Api返回的数据 | | taskId | String | 否 | 任务Id | | serverId | String | 否 | 渲染服务器Id | | serverIp | String | 否 | 渲染服务器Ip | | publicIp | String | 否 | 渲染服务器公网Ip | | clientId | String | 否 | 客户端Id | | clientIp | String | 否 | 客户端Ip | | country | String | 否 | 客户端访问Ip对应的国家 | | province | String | 否 | 客户端访问Ip对应的省份 | | city | String | 否 | 客户端访问Ip对应的城市 | | appKey | String | 否 | 应用所属客户区分 | | appliId | String | 否 | 运行的应用Id | | appliType | String | 否 | 参见1.3.4 | | startProcType | String | 否 | 参见1.3.4 | | status | String | 否 | 任务状态 <br/>0:同步中。 <br/>1:就绪 <br/>3:运行中 <br/>9:已结束 | | startParam | String | 否 | 启动参数 | | startAt | String | 否 | 开始运行时间 | | limitMaxFps | Integer | 否 | 参见1.3.4 | | offScreen | Integer | 否 | 参见1.3.4 | | useGamepad | Integer | 否 | 参见1.3.4 | | playerMode | Integer | 否 | 该任务的运行模式。<br/>0:普通模式,<br/>1:演示模式,<br/>2:互动模式 | | roomCode(3.2.21版本废弃) | String | 否 | 当运行模式为演示模式或互动模式时,演示者创建房间的口令。 | | authCode(3.2.21版本新增) | String | 否 | 当运行模式为演示模式或互动模式时,演示者创建房间的口令。 | | nickname | String | 否 | 用户的昵称 | | playerListToggle | Integer | 否 | 演示/互动模式是否显示用户列表,默认为1;0:否,1:是 | | adminViewer | Integer | 否 | 是否为后天远程管理管理窗口,0:否,1:是 | | appliName | String | 否 | 运行应用的名称 | | offScreen | Integer | 否 | 是否离屏渲染,离屏渲染时能减少部分资源消耗,默认是1。0:不是。1:是 | | shareUrl | String | 否 | 演示模式下的玩家列表是否显示分享的连接| | reserveFlag | Integer | 否 | 是否开启了预启动。1:是, 0:否 | | createDate | String | 否 | 任务创建时间 | | updateDate | String | 否 | 任务更新时间 | **返回示例** ``` { "code": 1000, "message": "Success", "result": { "taskId": "887694373456707584", "serverId": "755167622919618560", "serverIp": "192.168.31.17", "publicIp": "", "clientIp": "175.162.5.49", "country": "中国", "province": "辽宁省", "city": "大连市", "appKey": "Jx3wQMD1", "appliId": "755187253461909504", "appliName": "汽车拆装", "appliType": 2, "startProcType": 0, "status": 3, "startParam": "/20200914220043407\\BciaEgis\\Binaries\\Win64\\BciaEgis-Win64-Shipping.exe BciaEgis 887694373456707584", "startAt": "1631684431220", "limitMaxFps": 1, "offScreen": 0, "useGamepad": 0, "playerMode": 1, "roomCode": "Sbvisavr", "nickname": "fdfdsf", "playerListToggle": 1, "adminViewer": 0, "createDate": "1631684431220", "updateDate": "1631684432523", "shareUrl": "true", "wm": "3", "dcs": 1, "reserveFlag": 0 } } ```
pxy_ssl
2025年3月13日 19:20
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
开发者交流群
QQ群号:1011308692
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期