获取参数设置信息


简要描述
请求URL
  • {{adminHost:8181}}/sysSetting/get
请求方式
  • get
Header
字段名 示例值 必选 类型 说明
adminKey 603284317954637824 string 该参数为后台管理接入凭证,在LarkXR3.3后台接入管理中查看
timestamp 8641706679604867 string 发送请求时的时间戳,单位为毫秒
signature 9A02B47AE67664D80A2ED13FC2B1691512613790 string 该参数为密钥签名。将adminKey(LarkXR3.2后台接入管理中查看)和adminSecret(LarkXR3.3后台中接入管理查看)和当前时间戳(long型数值)按字母序排序,然后进行SHA-1摘要签名。请参考【获取凭证签名】的样例
成功返回示例
{
  "code": 1000,
  "message": "Success",
  "result": [
    {
      "id": 5,
      "ssKey": "DISPATCH_POLICY",
      "ssValue": "2",
      "note": "选择简易模式时的注意事项:1)通常使用在公有云,应用已经打包进镜像中,使用该镜像批量创建服务器场景中。2)系统在分配时,不再检测同步记录和服务器异构因子。默认每个服务器已经同步好应用,且各个服务器权重相同。",
      "updateDate": "1684723841647"
    },
    {
      "id": 10,
      "ssKey": "IP_WHITELIST_ENABLED",
      "ssValue": "true",
      "note": "",
      "updateDate": "1605801600001"
    },
    {
      "id": 25,
      "ssKey": "STORE_TYPE",
      "ssValue": "0",
      "note": "上传完应用后不可以更改存储方式,请慎重选择,默认本地存储",
      "updateDate": "1705298122868"
    },
    {
      "id": 30,
      "ssKey": "USE_APPLI_LIST_PAGE",
      "ssValue": "0",
      "note": "",
      "updateDate": "1694595276139"
    },
    {
      "id": 40,
      "ssKey": "STORE_METRICS",
      "ssValue": "1",
      "note": "默认值:否(不保存)",
      "updateDate": "1690358515839"
    },
    {
      "id": 45,
      "ssKey": "STORE_METRICS_EXPIRE",
      "ssValue": "30",
      "note": "单位:天,默认值:10",
      "updateDate": "1658739660163"
    },
    {
      "id": 50,
      "ssKey": "STORE_SERVER_USAGE",
      "ssValue": "0",
      "note": "默认值:否(不保存),占用磁盘空间谨慎开启",
      "updateDate": "1690356417817"
    },
    {
      "id": 60,
      "ssKey": "WELCOME_LOGO",
      "ssValue": "/getCstzLogoUrl?logoType=welcome",
      "note": "推荐尺寸:273*210",
      "updateDate": "1605801600001"
    },
    {
      "id": 65,
      "ssKey": "VR_CLIENT_HEADER_LOGO",
      "ssValue": "/getCstzLogoUrl?logoType=header",
      "note": "推荐尺寸:134*51",
      "updateDate": "1605801600001"
    },
    {
      "id": 70,
      "ssKey": "INDEX_LOGO",
      "ssValue": "/images/LarkXR_index.png",
      "note": "推荐尺寸:200*32",
      "updateDate": "1634096281410"
    },
    {
      "id": 75,
      "ssKey": "NO_OPERATION_TIMEOUT",
      "ssValue": "302",
      "note": "单位:秒。指定时间内无操作将释放连接,0:表示一直保持连接。",
      "updateDate": "1704422237972"
    },
    {
      "id": 80,
      "ssKey": "ADMIN_LOGO",
      "ssValue": "/images/LarkXR_admin.png?date=1634096317317",
      "note": "推荐尺寸:200*32",
      "updateDate": "1634096317575"
    },
    {
      "id": 85,
      "ssKey": "DETECT_RTT_FLAG",
      "ssValue": "1",
      "note": "多区域部署时是否开启RTT探测来辅助分配渲染请求",
      "updateDate": "1661416311777"
    },
    {
      "id": 90,
      "ssKey": "JOYSTICK_LOGO",
      "ssValue": "/images/LarkXR_joystickLogo.png?date=1690510190076",
      "note": "推荐尺寸:254*254",
      "updateDate": "1690511971545"
    },
    {
      "id": 91,
      "ssKey": "JOYSTICK_CENTER_LOGO",
      "ssValue": "/images/LarkXR_joystickCenterLogo.png",
      "note": "推荐尺寸:86*86",
      "updateDate": "1679621017953"
    },
    {
      "id": 92,
      "ssKey": "CONTROLBAR_LOGO",
      "ssValue": "/getCstzLogoUrl?logoType=controlBar",
      "note": "推荐尺寸:86*86",
      "updateDate": "1605801600001"
    },
    {
      "id": 100,
      "ssKey": "SEND_NOTICE",
      "ssValue": "0",
      "note": "关闭离线/抖动短信通知之后,即使配置文件中配置了离线短信通知模板,也不会触发短信通知。注意:在人为停止服务的时候,请关闭此项通知",
      "updateDate": "1605801600001"
    },
    {
      "id": 105,
      "ssKey": "pxy:admin:ratelimit:startappli",
      "ssValue": "50",
      "note": "",
      "updateDate": "1692348141590"
    },
    {
      "id": 110,
      "ssKey": "pxy:admin:ratelimit:clientinfo",
      "ssValue": "",
      "note": "",
      "updateDate": "1683702184827"
    },
    {
      "id": 115,
      "ssKey": "pxy:admin:ratelimit:clientlogerr",
      "ssValue": "",
      "note": "",
      "updateDate": "1683701658623"
    },
    {
      "id": 120,
      "ssKey": "pxy:admin:ratelimit:reportresource",
      "ssValue": "",
      "note": "",
      "updateDate": "1605801600001"
    },
    {
      "id": 125,
      "ssKey": "pxy:admin:ratelimit:getrunningapplilist",
      "ssValue": "",
      "note": "",
      "updateDate": "1683342869711"
    },
    {
      "id": 130,
      "ssKey": "pxy:admin:ratelimit:getrunningcnt",
      "ssValue": "",
      "note": "",
      "updateDate": "1605801600001"
    },
    {
      "id": 135,
      "ssKey": "pxy:admin:ratelimit:getruncntandservercnt",
      "ssValue": "",
      "note": "",
      "updateDate": "1605801600001"
    },
    {
      "id": 140,
      "ssKey": "pxy:admin:ratelimit:clientstarted",
      "ssValue": "",
      "note": "",
      "updateDate": "1605801600001"
    }
  ]
}
成功返回示例的参数说明
参数名 类型 说明
code string
message string
result array
id string
ssKey string 键,键值对应描述请参考备注
ssValue string 值,键值对应描述请参考备注
note string 说明
updateDate string
备注

5)【DISPATCH_POLICY】分配规则。 2:通用分配规则,3:建议分配规则。
10)【IP_WHITELIST_ENABLED】是否开启IP白名单。 true:开启,false:关闭。
25)【STORE_TYPE】应用存储类型。 0:本地存储,1:Minio存储,2:阿里OSS,3:华为OBS,4:AWS S3。
30)【USE_APPLI_LIST_PAGE】是否开启前端一览。 0:否,1:是。
40)【STORE_METRICS】是否保存VR监控数据。 0:否,1:是。
45)【STORE_METRICS_EXPIRE】VR监控数据保存期限。 天数。
50)【STORE_SERVER_USAGE】是否保存渲染服务器资源使用率数据。 0:否,1:是。
60)【WELCOME_LOGO】 启动页中心Logo。开发版授权可以替换
65)【VR_CLIENT_HEADER_LOGO】VR客户端左上角Logo。 开发版授权可以替换。
70)【INDEX_LOGO】一览页Logo。
75)【NO_OPERATION_TIMEOUT】无操作时限(秒)。
80)【ADMIN_LOGO】管理后台Logo。
85)【DETECT_RTT_FLAG】是否开启RTT探测。 0:否,1:是。
90)【JOYSTICK_LOGO】圆盘底图。
91)【JOYSTICK_CENTER_LOGO】圆盘中心按钮。
92)【CONTROLBAR_LOGO】控制球。
100)【SEND_NOTICE】是否允许节点离线/抖动短信通知。 0:否,1:是。
105)【pxy:admin:ratelimit:startappli】 /appli/getStartInfo、/appli/getStartURL、/appli/start接口限流数量。
110)【pxy:admin:ratelimit:clientinfo】 /client/info接口限流数量。
115)【pxy:admin:ratelimit:clientlogerr】 /client/log/error接口限流数量。
120)【pxy:admin:ratelimit:reportresource】 /client/reportResource接口限流数量。
125)【pxy:admin:ratelimit:getrunningapplilist】 /taskInfo/getRunningAppliList接口限流数量。
130)【pxy:admin:ratelimit:getrunningcnt】/taskInfo/getRunningCnt接口限流数量。
135)【pxy:admin:ratelimit:getruncntandservercnt】 /taskInfo/getRunCntAndServerCnt接口限流数量。
140)【pxy:admin:ratelimit:clientstarted】 /taskInfo/clientStarted接口限流数量。


zhousn 2025年3月12日 16:41 收藏文档

开发者交流群

QQ群号:1011308692