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.11.1参数设置查询
**1.11.1参数设置查询** | 请求方式 | GET | | ------------ | ------------ | | **请求URL** | http: // {LarkXR3.2管理服务器IP}:8181/sysSetting/get | **参考样例** ``` 说明:adminKey,timestamp,signature这三个参数有两种方式传递 一种是以参数的形式传递,例如:http://192.168.1.11:8282/sysSetting/get?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/sysSetting/get"); ``` ##### 返回示例 ``` { "code": 1000, "message": "Success", "result": [ { "id": 5, "title": "请求分配策略", "titleEn": "DISPATCH_POLICY", "ssKey": "DISPATCH_POLICY", "ssValue": "2", "note": "选择简易模式时的注意事项:1)通常使用在公有云,应用已经打包进镜像中,使用该镜像批量创建服务器场景中。2)系统在分配时,不再检测同步记录和服务器异构因子。默认每个服务器已经同步好应用,且各个服务器权重相同。", "noteEn": "Precautions when selecting the simple mode: It is usually used in the public cloud. Applications have been packaged in the image, and the image is used to batch create server scenarios. During allocation, the system no longer detects synchronization records and server heterogeneity factors. By default, each server has synchronized the application, and the weight of each server is the same", "createDate": "1605801600001", "updateDate": "1684723841647" }, { "id": 10, "title": "启用IP白名单", "titleEn": "IP_WHITELIST_ENABLED", "ssKey": "IP_WHITELIST_ENABLED", "ssValue": "true", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 25, "title": "存储类型", "titleEn": "Store Type", "ssKey": "STORE_TYPE", "ssValue": "0", "note": "上传完应用后不可以更改存储方式,请慎重选择,默认本地存储", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 30, "title": "开启应用列表辅助页面", "titleEn": "Using Appli List Page", "ssKey": "USE_APPLI_LIST_PAGE", "ssValue": "0", "createDate": "1605801600001", "updateDate": "1679465232698" }, { "id": 35, "title": "默认客户区分", "titleEn": "Default AppKey", "ssKey": "DEFAULT_APPKEY", "ssValue": "Jx3wQMD1", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 40, "title": "保存云VR度量数据", "titleEn": "Store CloudVR Metrics", "ssKey": "STORE_METRICS", "ssValue": "1", "note": "默认值:否(不保存)", "noteEn": "Default:0(Not Store)", "createDate": "1605801600001", "updateDate": "1658739664410" }, { "id": 45, "title": "云VR度量数据保存期限", "titleEn": "CloudVR Metrics Expire", "ssKey": "STORE_METRICS_EXPIRE", "ssValue": "30", "note": "单位:天,默认值:10", "noteEn": "Unit:day, Default:10", "createDate": "1605801600001", "updateDate": "1658739660163" }, { "id": 50, "title": "保存服务器使用率数据", "titleEn": "Store Server Usage", "ssKey": "STORE_SERVER_USAGE", "ssValue": "0", "note": "默认值:否(不保存),占用磁盘空间谨慎开启", "noteEn": "Default:0(Not Store)", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 60, "title": "启动页中心Logo", "titleEn": "Welcome Logo", "ssKey": "WELCOME_LOGO", "ssValue": "/getCstzLogoUrl?logoType=welcome", "note": "推荐尺寸:273*210", "noteEn": "Recommend Size:273*210", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 65, "title": "VR客户端左上角Logo", "titleEn": "VR Client Header Logo", "ssKey": "VR_CLIENT_HEADER_LOGO", "ssValue": "/getCstzLogoUrl?logoType=header", "note": "推荐尺寸:134*51", "noteEn": "Recommend Size:134*51", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 70, "title": "一览页Logo", "titleEn": "Index Logo", "ssKey": "INDEX_LOGO", "ssValue": "/images/LarkXR_index.png?date=1634096278982", "note": "推荐尺寸:200*32", "noteEn": "Recommend Size:200*32", "createDate": "1605801600001", "updateDate": "1634096281410" }, { "id": 75, "title": "无操作时限", "titleEn": "No Operation Timeout", "ssKey": "NO_OPERATION_TIMEOUT", "ssValue": "300", "note": "单位:秒。指定时间内无操作将释放连接,0:表示一直保持连接。", "noteEn": "Unit: Second。No operation will release the connection within a specified time, 0: means that the connection has been maintained.", "createDate": "20190507132708", "updateDate": "1686123090352" }, { "id": 80, "title": "管理后台Logo", "titleEn": "Admin Logo", "ssKey": "ADMIN_LOGO", "ssValue": "/images/LarkXR_admin.png?date=1634096317317", "note": "推荐尺寸:200*32", "noteEn": "Recommend Size:200*32", "createDate": "1605801600001", "updateDate": "1634096317575" }, { "id": 85, "title": "RTT探测标识", "titleEn": "Detect RTT FLag", "ssKey": "DETECT_RTT_FLAG", "ssValue": "1", "note": "多区域部署时是否开启RTT探测来辅助分配渲染请求", "noteEn": "When multi region deployment, whether to enable RTT detection to assist in dispatching rendering requests", "createDate": "1605801600001", "updateDate": "1661416311777" }, { "id": 90, "title": "圆盘底图", "titleEn": "Joystick Logo", "ssKey": "JOYSTICK_LOGO", "ssValue": "/images/LarkXR_joystickLogo.png", "note": "推荐尺寸:254*254", "noteEn": "Recommend Size:254*254", "createDate": "1605801600001", "updateDate": "1679621029483" }, { "id": 91, "title": "圆盘中心按钮", "titleEn": "Joystick Center Logo", "ssKey": "JOYSTICK_CENTER_LOGO", "ssValue": "/images/LarkXR_joystickCenterLogo.png", "note": "推荐尺寸:86*86", "noteEn": "Recommend Size:86*86", "createDate": "1605801600001", "updateDate": "1679621017953" }, { "id": 92, "title": "控制球", "titleEn": "Control Bar Logo", "ssKey": "CONTROLBAR_LOGO", "ssValue": "/getCstzLogoUrl?logoType=controlBar", "note": "推荐尺寸:86*86", "noteEn": "Recommend Size:86*86", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 100, "title": "是否允许节点离线/抖动短信通知", "titleEn": "Send Notice", "ssKey": "SEND_NOTICE", "ssValue": "0", "note": "关闭离线/抖动短信通知之后,即使配置文件中配置了离线短信通知模板,也不会触发短信通知。注意:在人为停止服务的时候,请关闭此项通知", "noteEn": "After offline/dithering SMS notification is closed, even if offline SMS notification template is configured in the configuration file, SMS notification will not be triggered. Usually, this notification is closed when the service is stopped manually", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 105, "title": "流控ID:StartAppli", "titleEn": "Flow Control ID: StartAppli", "ssKey": "pxy:admin:ratelimit:startappli", "ssValue": "50", "createDate": "1605801600001", "updateDate": "1683342953739" }, { "id": 110, "title": "流控ID:ClientInfo", "titleEn": "Flow Control ID: ClientInfo", "ssKey": "pxy:admin:ratelimit:clientinfo", "createDate": "1605801600001", "updateDate": "1683702184827" }, { "id": 115, "title": "流控ID:ClientLogErr", "titleEn": "Flow Control ID: ClientLogErr", "ssKey": "pxy:admin:ratelimit:clientlogerr", "createDate": "1605801600001", "updateDate": "1683701658623" }, { "id": 120, "title": "流控ID:ReportResource", "titleEn": "Flow Control ID: ReportResource", "ssKey": "pxy:admin:ratelimit:reportresource", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 125, "title": "流控ID:GetRunningAppliList", "titleEn": "Flow Control ID: GetRunningAppliList", "ssKey": "pxy:admin:ratelimit:getrunningapplilist", "createDate": "1605801600001", "updateDate": "1683342869711" }, { "id": 130, "title": "流控ID:GetRunningCnt", "titleEn": "Flow Control ID: GetRunningCnt", "ssKey": "pxy:admin:ratelimit:getrunningcnt", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 135, "title": "流控ID:GetRunCntAndServerCnt", "titleEn": "Flow Control ID: GetRunCntAndServerCnt", "ssKey": "pxy:admin:ratelimit:getruncntandservercnt", "createDate": "1605801600001", "updateDate": "1605801600001" }, { "id": 140, "title": "流控ID:ClientStarted", "titleEn": "Flow Control ID: ClientStarted", "ssKey": "pxy:admin:ratelimit:clientstarted", "createDate": "1605801600001", "updateDate": "1605801600001" } ] } ``` ##### 返回参数说明 |参数名|类型|说明| |:----- |:-----|----- | |code |string| 返回状态| |message| string| 返回消息| |result| array| 返回结果| |id| string| id| |title| string| 名称| |titleEn| string| 名称-英文| |ssKey| string| ssKey| |ssValue| string| ssValue| |note| string| 说明| |noteEn| string| 说明-英文| |createDate| string| 无| |updateDate| string| 无|
pxy_ssl
2025年3月13日 19:55
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
开发者交流群
QQ群号:1011308692
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期