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.6.1渲染节点查询(分页
**1.6.1渲染节点查询(分页)** | 请求方式 | GET | | ------------ | ------------ | | **请求URL** | http: // {LarkXR3.2管理服务器IP}:8181/renderServer/search | **升级说明** - 接口参数去除serverName筛选条件,增加regionId,status - 返回结果中 ,firstFailDateInPeriod 由原来的时间格式转换为Integer时间戳格式 - 返回结果中 ,节点状态由:【1:有效 5:抖动 9:离线】变更为:【1:有效 3:冻结 5:抖动 11:离线 14:离线冻结 】 - 返回结果中 ,公网IP由publicAddress更改为publicIp - 返回结果中 ,优先使用的局域网出口IP由preferPubOutIp更改为preferPublicIp - 返回结果中 ,去除runCnt - 返回结果中 ,增加SSL域名(certDomainUrl)和端口(sslPort),用于https环境 **参考样例** ``` 说明:adminKey,timestamp,signature这三个参数有两种方式传递 一种是以参数的形式传递,例如:http://192.168.1.11:8181/renderServer/search?adminKey=60329936665467& timestamp=1585729005673&signature=4C1BFE264A113A99C526BF5565EEBE642792A0B6 另一种是在OkHttp请求的header中传递,例如 : Request.Builder builder = new Request.Builder(). addHeader("adminKey", "60329936665467") .addHeader("timestamp", "1585729005673") .addHeader("signature", "4C1BFE264A113A99C526BF5565EEBE642792A0B6") .url("http://192.168.1.11:8181/renderServer/search"); ``` |名称 | 类型 | 是否必须 |描述| | ------------ | ------------ | ------------ |------------ | | regionId | String | 否 |服务器所属区域Id,在启动渲染服务时,在启动管理器配置的集群分区ID| | status | Integer | 否 |节点状态,| | serverIp | String | 否 |服务器节点Ip| | page | Integer | 否 | | | pageSize | Integer | 否 |默认为20 | | adminKey | String | 是 | 参见1.3.1 | | timestamp | Long | 是 | 参见1.3.1 | | signature | String | 是 | 参见1.3.1 | 返回结果: |名称 | 类型 | 是否必须 | 描述 | | ------------ | ------------ | ------------ | ------------ | |code | Integer | 是 | 返回状态 | |message | String | 否 |返回消息 | | result | String | 否 | Code=1000的时候,Api返回的数据 | | serverId | String | 是 | 服务器Id | | serverName | String | 是 | 服务器名称 | | regionId | String | 是 | 渲染服务器所属的区域Id | | regionName | String | 是 | 渲染服务器所属的区域名称 | | status | Integer | 是 | 1:有效 3:冻结 5:抖动 11:离线 14:离线冻结| | failCntInPeriod | Integer | 是 | 一个周期内失败(离线或者抖动)的次数 | | certDomainUrl | String | 是 | SSL域名 | | sslPort | Integer | 是 | SSL端口 | | firstFailDateInPeriod | String | 否 | 一个周期内失败(离线或者抖动)的时间点 | | serverIp | String | 是 | 渲染服务器Ip | | publicIp | String | 否 | 公网Ip | | preferPublicIp | String | 否 | 优先使用的局域网出口Ip | | serverPort | Integer | 是 | 渲染服务端口 | | syncPort | Integer | 是 | 同步服务端口 | | coefficient | Integer | 是 | 服务器的异构因子,默认为100。值越大表明服务器性能越佳,支撑的并发数越高。 | | syncing | boolean | 是 | 是否正在同步:false表示没有正在同步 | | groupName | Array | 否 | 组别名称;渲染节点没有绑定组别时,返回是[] | | groupId | Array | 否 | 组别Id;渲染节点没有绑定组别时,返回是[] | | createDate | long | 是 | 创建时间 | | updateDate | long | 是 | 更新时间 | **返回示例** ``` { "code": 1000, "message": "Success", "result": { "records": [ { "serverId": "885610331710160896", "serverName": "Node-1", "regionId": "HB1", "regionName": "华北1", "status": 1, "failCntInPeriod": 0, "firstFailDateInPeriod": "0", "serverIp": "192.168.0.28", "serverPort": 10002, "syncPort": 8899, "certDomainUrl": "www.pingxingyun.com", "sslPort": 10004, "mid": "c255ced0be4451c5ba5524b926a53816", "coefficient": 100, "createDate": "1631187556924", "updateDate": "1631848426770", "syncing": false "groupId": [ "826837364692221922" ], "groupName": [ "北京服务器" ] }, ], "total": "8", "size": "20", "current": "1", "orders": [], "searchCount": true, "pages": "1" } } ```
pxy_ssl
2025年3月13日 19:20
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
开发者交流群
QQ群号:1011308692
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期