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.10.4获取服务端资源监控数据
**1.10.4获取服务端资源监控数据** | 请求方式 | GET | | ------------ | ------------ | | **请求URL** | http: //{LarkXR3.2管理服务器IP}:8181/watch/getResourceUsageDetails| **升级说明** - 接口地址由“/watch/getResourceUsageDetails”改为“/renderServer/monitor”,端口由默认的8282变为8181 - 接口改为分页查询 - 返回结果中,渲染节点的相关信息,保存到result.appServers.records.resourceUsageList中 **参考样例** ``` 说明:adminKey,timestamp,signature这三个参数有两种方式传递 一种是以参数的形式传递,例如:http://192.168.1.11:8282/renderServer/monitor?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:8282/renderServer/monitor"); ``` |名称 | 类型 | 是否必须 |描述| | ------------ | ------------ | ------------ |------------ | | serverIp | String | 否 |服务器Ip| | regionId | String | 否 |集群分区ID| | status | String | 否 |1:有效 3:冻结 5:抖动 11:离线 14:离线冻结| | page | Integer | 否 | 当前页码 | | pageSize | Integer | 否 | 每页含有多少条数据| | adminKey | String | 是 | 参见1.3.1 | | timestamp | Long | 是 | 参见1.3.1 | | signature | String | 是 | 参见1.3.1 | 返回结果: |名称 | 类型 | 是否必须 | 描述 | | ------------ | ------------ | ------------ | ------------ | |code | Integer | 是 | 返回状态 | |message | String | 否 |返回消息 | | result.diskHighCnt | Integer | 否 | 磁盘负载过高的节点数量 | | result.totalCnt | Integer | 否 | 系统总并发数 | | result.ramHighCnt | Integer | 否 | 内存负载过高节点数量 | | result.gpuHighCnt | Integer | 否 | GPU负载过高的节点数量 | | result.inactiveCnt | Integer | 否 | 抖动节点数量 | | result.cpuHighCnt | Integer | 否 | CPU负载过高节点数量 | | result.offlineCnt | Integer | 否 | 离线节点数量 | | result.appServers | Integer | 否 | 渲染节点列表 | | result.appServers.records | Integer | 否 | 渲染节点列表,字段含义请参考1.6.1节点管理 | | result.appServers.records.resourceUsageList.serverId | Integer | 否 | 服务器Id | | result.appServers.records.resourceUsageList.serverName | Integer | 否 | 服务器名称 | | result.appServers.records.resourceUsageList.serverIp | Integer | 否 | 服务器Ip | | result.appServers.records.resourceUsageList.cpuType0 | Integer | 否 | CPU0的型号 | | result.appServers.records.resourceUsageList.cpuUsage0 | Integer | 否 | CPU0使用率 单位:% | | result.appServers.records.resourceUsageList.cpuType1 | Integer | 否 | CPU1的型号 | | result.appServers.records.resourceUsageList.cpuUsage1 | Integer | 否 | CPU1使用率 单位:% | | result.appServers.records.resourceUsageList.gpuType0 | Integer | 否 | GPU0的型号 | | result.appServers.records.resourceUsageList.gpuUsage0 | Integer | 否 | GPU0的使用率 单位:% | | result.appServers.records.resourceUsageList.gpuType1 | Integer | 否 | GPU1的型号 | | result.appServers.records.resourceUsageList.gpuUsage1 | Integer | 否 | GPU1的使用率 单位:% | | result.appServers.records.resourceUsageList.gpuType2 | Integer | 否 | GPU2的型号 | | result.appServers.records.resourceUsageList.gpuUsage2 | Integer | 否 | GPU2的使用率 单位:% | | result.appServers.records.resourceUsageList.gpuType3 | Integer | 否 | GPU3的型号 | | result.appServers.records.resourceUsageList.gpuUsage3 | Integer | 否 | GPU3的使用率 单位:% | | result.appServers.records.resourceUsageList.totalMem | Integer | 否 | 总内存 单位:M | | result.appServers.records.resourceUsageList.freeMem | Integer | 否 | 空闲的内存 单位:M | | result.appServers.records.resourceUsageList.sendRate | Integer | 否 | 发送速率 单位:KB/s | | result.appServers.records.resourceUsageList.recvRate | Integer | 否 | 接收速率 单位:KB/s | | result.appServers.records.resourceUsageList.diskId0 | Integer | 否 | 部署盘符的磁盘ID,例如“C”,“D” | | result.appServers.records.resourceUsageList.diskTotal0 | Integer | 否 | 部署盘符的总磁盘空间 | | result.appServers.records.resourceUsageList.diskFree0 | Integer | 否 | 部署盘符的剩余磁盘空间 | | result.appServers.records.resourceUsageList.createDate | Long | 否 | 创建时间 | **返回示例** ``` { "code": 1000, "message": "Success", "result": { "diskHighCnt": 0, "totalCnt": "0", "ramHighCnt": 0, "gpuHighCnt": 0, "inactiveCnt": 0, "cpuHighCnt": 0, "offlineCnt": 0, "appServers": { "records": [ { "serverId": "755167622919618560", "serverName": "BJ001", "regionId": "BJ", "regionName": "北京", "status": 1, "failCntInPeriod": 39083, "firstFailDateInPeriod": "20210714174107", "serverIp": "192.168.31.17", "publicIp": "", "preferPublicIp": "222.128.6.137", "serverPort": 10002, "syncPort": 8899, "certDomainUrl": "pxy.render-server.credential.cert-domain-url", "sslPort": 10004, "mid": "5835091a463820b9c037b671a6c055a5", "coefficient": 100, "createDate": "1600087592000", "updateDate": "1631930151090", "runCnt": 0, "syncing": false, "groupId": [ "826837364692221952", "827500147003883520", "830022480058908672", "884406858050174976", "816351359270912000" ], "groupName": [ "北京服务器", "测试Steam独占", "VR虚拟人", "17,18", "VR" ], "resourceUsageList": [ { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12121, "sendRate": 2.072, "recvRate": 5.803, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930153007" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.52, "recvRate": 4.463, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930152006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.009, "recvRate": 6.442, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930151105" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 3.243, "recvRate": 4.219, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930150009" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.009, "recvRate": 4.614, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930149006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 1.929, "recvRate": 4.147, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930148006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.009, "recvRate": 4.593, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930147006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.593, "recvRate": 3.806, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930146007" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.593, "recvRate": 4.54, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930145006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.794, "recvRate": 7.302, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930144006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.639, "recvRate": 5.094, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930143008" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 1.929, "recvRate": 4.032, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930142006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.201, "recvRate": 4.548, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930141006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 3.371, "recvRate": 3.911, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930140006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.009, "recvRate": 4.021, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930139007" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 1.929, "recvRate": 3.364, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930138007" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.009, "recvRate": 4.021, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930137006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.656, "recvRate": 3.984, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930136006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.86, "recvRate": 5.17, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930135006" }, { "serverId": "755167622919618560", "serverName": "BJ001", "serverIp": "192.168.31.17", "cpuType0": "Intel(R) Core(TM ) i7-8700K CPU @ 3.70GHz", "cpuUsage0": 0, "gpuType0": "GeForce GTX 1060 6GB", "gpuUsage0": 0, "totalMem": 16226, "freeMem": 12122, "sendRate": 2.602, "recvRate": 7.815, "diskId0": "D", "diskTotal0": 465, "diskFree0": 123, "diskId1": "D", "diskTotal1": 465, "diskFree1": 123, "createDate": "1631930134006" } ] } ], "total": "1", "size": "20", "current": "1", "orders": [], "searchCount": true, "pages": "1" } } } ```
admin
2025年3月13日 19:20
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
开发者交流群
QQ群号:1011308692
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期