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.3.2 上传应用程序包接口
**1:分片上传程序包** 1)获取uploadId | 请求类型 | GET | | ------------ | ------------ | | **请求URL** |http: //{LarkXR3.2管理服务器IP}:8181/appli/getUploadId | **参考样例** ``` 说明:adminKey,timestamp,signature这三个参数有两种方式传递 一种是以参数的形式传递,例如:http://192.168.1.11:8181/appli/getUploadId?adminKey=603299366654678855& timestamp=1585729005673&signature=4C1BFE264A113A99C526BF5565EEBE642792A0B6 另一种是在OkHttp请求的header中传递,例如 : Request.Builder builder = new Request.Builder(). addHeader("adminKey", "603299366654678855") .addHeader("timestamp", "1585729005673") .addHeader("signature", "4C1BFE264A113A99C526BF5565EEBE642792A0B6") .url("http://192.168.1.11:8181/appli/getUploadId"); ``` | 名称 | 类型 | 是否必须 | 描述 | | ------------ | ------------ | ------------ | ------------ | | adminKey | String | 是 | 参见1.3.1 | | timestamp | Long | 是 | 参见1.3.1 | | signature | String | 是 | 参见1.3.1 | 返回结果: | 名称 | 类型 | 是否非空 | 描述 | | ------------ | ------------ | ------------ | ------------ | | code | Integer | 是 | 返回状态 | | message | String | 否 | 返回消息 | |result |String | 否 | uploadId | 2)分片上传 | 请求类型 | POST | | ------------ | ------------ | | **请求URL** |http: //{LarkXR3.2中心服务器的IP}:8181/appli/sliceUpload | **参考样例** | 名称 | 类型 | 是否非空 | 描述 | | ------------ | ------------ | ------------ | ------------ | | uploadId | String | 是 | 文件上传标识 | | chunkIndex | int | 是 | 当前为第几分片,从0开始,取值0-9999 | | chunkStart | Long | 是 | 当前分片在文件中的起始位置 | | chunkSize | Long | 是 | 每个分块的大小,除了最后一个分片没有大小限制,其他的分片最小为100 KB,不大于20M(单位:Byte) | | totalSize | Long | 是 | 文件总大小 | | totalChunkCnt | int | 是 | 分片数量,不能超过10000 | | originalFilename | String | 是 | 文件名称 | | chunk | MultipartFile | 是 | 文件分块 | | adminKey | String | 是 | 参见1.3.1的参数说明 | | timestamp | Long | 是 | 参见1.3.1的参数说明 | | signature | String | 是 | 参见1.3.1的参数说明 | 返回结果: | 名称 | 类型 | 是否非空 | 描述 | | ------------ | ------------ | ------------ | ------------ | | code | Integer | 是 | 返回状态 | | message | String | 否 | 返回消息 | | result |Object | 否 | Code=1000的时候,Api返回的数据 | | completeType | String | 是 | 0:文件分片上传完成,1整个文件上传完成 | | trunkIndex| String | 是 | 当前为第几分片| | fileSize | String | 是 | 应用程序包大小| | appliPath | String | 是 | 应用存储文件夹名称 | | zipFilePath | String | 是 | zip包的完整路径 | | isUnzipEnable | String | 是 | 是否解压标识 ,true表示后端解压,false表示后端未解压| | exeFileNameList | Array | 否 | 采用本地存储且应用程序为Windows平台应用时,返回zip包中的exe文件路径列表 | **2: form表单形式上传应用程序包** | 请求类型 | POST | | ------------ | ------------ | | **请求URL** |http: //{LarkXR3.2中心服务器的IP}:8181/appli/upload | **升级说明** - 接口地址由 “/vrAppli/upload”变更为“/appli/upload”,默认端口由8282变为8181 - 应用程序包参数由“vrFile”变更为“zipFile” - 去除fileName的返回值 - 返回值filePath更改为appliPath - 不同存储类型返回值格式格式会有少许不同,可以参考下面的返回样例。 **参考样例** ``` 说明: 使用方法一:直接使用js调用接口【推荐】 var param = new FormData(); param.append('zipFile', f.file); axios({ method: 'post', url: 'http://192.168.1.11:8181/vrAppli/upload', data: param, headers: { 'Content-Type': 'multipart/form-data', 'adminKey':'603299366654678855' , 'timestamp':'1585729005673' , 'signature':'4C1BFE264A113A99C526BF5565EEBE642792A0B6' } }) $.ajax({ url:'http://192.168.0.11:8181/appli/upload', data:param, contentType: false, processData: false, type:"POST", headers: { 'adminKey':'603284317954637824' , 'timestamp':'1585729005673' , 'signature':'4C1BFE264A113A99C526BF5565EEBE642792A0B6' }, }) 使用方法二:OkHttp请求 adminKey,timestamp,signature这三个参数需要在OkHttp请求的header中传递 样例: try { String filePath ="C:\\Apps"; new File(filePath).mkdirs(); String fullPath = filePath + File.separator + zipFile.getOriginalFilename(); File file = new File(fullPath); vrFile.transferTo(file); MultipartBody.Builder requestBody = new MultipartBody.Builder().setType(MultipartBody.FORM); requestBody.addFormDataPart("zipFile", zipFile.getOriginalFilename(),RequestBody.create(MediaType.parse("application/octet-stream"),file)); Request.Builder builder = new Request.Builder(). addHeader("adminKey", "603299366654678855") .addHeader("timestamp", "1585729005673") .addHeader("signature", "4C1BFE264A113A99C526BF5565EEBE642792A0B6") .url("http://192.168.1.11:8181/appli/upload"); builder.post(requestBody.build()); Request request = builder.build(); OkHttpClient client = OkHttpClientUtil.getOkHttpClient(); Response response = client.newCall(request).execute();} ``` | 名称 | 类型 | 是否非空 | 描述 | | ------------ | ------------ | ------------ | ------------ | | zipFile | MultipartFile | 是 | 上传的应用程序包,必须以zip结尾 | | adminKey | String | 是 | 参见1.3.1 | | timestamp | Long | 是 | 参见1.3.1 | | signature | String | 是 | 参见1.3.1 | 返回结果: | 名称 | 类型 | 是否非空 | 描述 | | ------------ | ------------ | ------------ | ------------ | | code | Integer | 是 | 返回状态 | | message | String | 否 | 返回消息 | | result |Object | 否 | Code=1000的时候,Api返回的数据 | | appliPath | String | 是 | 应用程序包的保存目录 | | zipFilePath| String | 是 | zip包的完整路径 | | fileSize | String | 是 | 应用程序包大小 | | exeFileNameList | Array | 否 | 采用本地存储且应用程序为Windows平台应用时,返回zip包中的exe文件路径列表 | **说明:** 1)应用程序包需要压缩成zip格式。 2)添加/更新应用时使用该接口上传应用程序包。 3)返回的路径等信息,会在添加/更新应用接口中使用。 **返回信息格式:** 采用对象存储(Minio,OSS,OBS,S3)时,接口的返回格式: ``` { "code": 1000, "message": "上传完毕", "result": { "fullPath": "887351768835424256.zip", "fileSize": "1839631", "appliPath": "20210914145907888", "zipFilePath": "887351768835424256.zip" } } ``` 采用本地存储时,接口的返回格式: ``` { "code": 1000, "message": "上传完毕", "result": { "fullPath": "C://Lark3//Appli/20210914153922365/887362024428797952.zip", "fileSize": "1839631", "appliPath": "20210914153922365", "exeFileNameList": [ "7-Zip/7z.exe", "7-Zip/7zFM.exe", "7-Zip/7zG.exe", "7-Zip/Uninstall.exe" ], "zipFilePath": "C://Lark3//Appli/20210914153922365/887362024428797952.zip" } } ``` **3: 二进制流形式上传应用程序包** | 请求类型 | POST | | ------------ | ------------ | | **请求URL** |http: //{LarkXR3.2中心服务器的IP}:8181/appli/uploadByBinary | | 名称 | 类型 | 是否非空 | 描述 | | ------------ | ------------ | ------------ | ------------ | | adminKey | String | 是 | 参见1.3.1 | | timestamp | Long | 是 | 参见1.3.1 | | signature | String | 是 | 参见1.3.1 | 返回结果: | 名称 | 类型 | 是否非空 | 描述 | | ------------ | ------------ | ------------ | ------------ | | code | Integer | 是 | 返回状态 | | message | String | 否 | 返回消息 | | result |Object | 否 | Code=1000的时候,Api返回的数据 | | filePath | String | 是 | 应用程序包的保存目录 | | zipFilePath| String | 是 | zip包的完整路径 | | fullPath | String | 是 | 本地存储时应用程序包全路径名,Minio对象存储时,应用的zip包名称。注意:此返回值为了兼容3.1版本,计划在2021年12月31日去除,请尽量使用 zipFilePath替代| | fileSize | String | 是 | 应用程序包大小 | | exeFileNameList | Array | 否 | 本地存储时返回执行文件路径列表 ,Minio存储时无返回值 | **说明:** 1)应用程序包需要压缩成zip格式。 2)添加/更新应用时使用该接口上传应用程序包。 3)返回的路径等信息,会在添加/更新应用课口中使用。 **返回信息格式:** 采用对象存储(Minio,OSS,OBS,S3)时,接口的返回格式: ``` { "code": 1000, "message": "上传完毕", "result": { "fullPath": "887351768835424256.zip", "fileSize": "1839631", "appliPath": "20210914145907888", "zipFilePath": "887351768835424256.zip" } } ``` 采用本地存储时,接口的返回格式: ``` { "code": 1000, "message": "上传完毕", "result": { "fullPath": "C://Lark3//Appli/20210914153922365/887362024428797952.zip", "fileSize": "1839631", "appliPath": "20210914153922365", "exeFileNameList": [ "7-Zip/7z.exe", "7-Zip/7zFM.exe", "7-Zip/7zG.exe", "7-Zip/Uninstall.exe" ], "zipFilePath": "C://Lark3//Appli/20210914153922365/887362024428797952.zip" } } ```
pxy_ssl
2025年3月13日 19:20
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
开发者交流群
QQ群号:1011308692
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期