Request URL
{{adminHost:8181}}/sysSetting/get
Request Method
| Field Name |
Sample |
Required |
Type |
Note |
| adminKey |
603284317954637824 |
Yes |
string |
This parameter is for backend management access credentials, which can be viewed in LarkXR3.3 backend access management |
| timestamp |
8641706679604867 |
Yes |
string |
The timestamp when sending a request, in milliseconds |
| signature |
9A02B47AE67664D80A2ED13FC2B1691512613790 |
Yes |
string |
This parameter is a key signature. Sort the adminKey (viewed in LarkXR3.2 backend access management), adminSecret (viewed in LarkXR3.3 backend access management), and current timestamp (long value) in alphabetical order, and then perform SHA-1 summary signature. Please refer to the example of [Obtaining Voucher Signature] |
Success Response Example
{
"code": 1000,
"message": "Success",
"result": [
{
"id": 5,
"ssKey": "DISPATCH_POLICY",
"ssValue": "2",
"note": "Notes when choosing simple mode: 1) It is usually used in public clouds, where the application has already been packaged into an image. Use this image to batch create server scenarios. 2) The system no longer detects synchronization records and server heterogeneity factors during allocation. By default, each server has already synchronized the application and each server has the same weight.",
"updateDate": "1684723841647"
},
{
"id": 10,
"ssKey": "IP_WHITELIST_ENABLED",
"ssValue": "true",
"note": "",
"updateDate": "1605801600001"
},
{
"id": 25,
"ssKey": "STORE_TYPE",
"ssValue": "0",
"note": "After uploading the application, the storage method cannot be changed. Please choose carefully as it defaults to local storage",
"updateDate": "1705298122868"
},
{
"id": 30,
"ssKey": "USE_APPLI_LIST_PAGE",
"ssValue": "0",
"note": "",
"updateDate": "1694595276139"
},
{
"id": 40,
"ssKey": "STORE_METRICS",
"ssValue": "1",
"note": "Default value: No (do not save)",
"updateDate": "1690358515839"
},
{
"id": 45,
"ssKey": "STORE_METRICS_EXPIRE",
"ssValue": "30",
"note": "Unit: Day, default value: 10",
"updateDate": "1658739660163"
},
{
"id": 50,
"ssKey": "STORE_SERVER_USAGE",
"ssValue": "0",
"note": "Default value: No (do not save), use disk space carefully to enable",
"updateDate": "1690356417817"
},
{
"id": 60,
"ssKey": "WELCOME_LOGO",
"ssValue": "/getCstzLogoUrl?logoType=welcome",
"note": "Recommended size:273*210",
"updateDate": "1605801600001"
},
{
"id": 65,
"ssKey": "VR_CLIENT_HEADER_LOGO",
"ssValue": "/getCstzLogoUrl?logoType=header",
"note": "Recommended size:134*51",
"updateDate": "1605801600001"
},
{
"id": 70,
"ssKey": "INDEX_LOGO",
"ssValue": "/images/LarkXR_index.png",
"note": "Recommended size:200*32",
"updateDate": "1634096281410"
},
{
"id": 75,
"ssKey": "NO_OPERATION_TIMEOUT",
"ssValue": "302",
"note": "Unit: seconds. If there is no action within the specified time, the connection will be released, and 0: indicates that the connection will be maintained.",
"updateDate": "1704422237972"
},
{
"id": 80,
"ssKey": "ADMIN_LOGO",
"ssValue": "/images/LarkXR_admin.png?date=1634096317317",
"note": "Recommended size:200*32",
"updateDate": "1634096317575"
},
{
"id": 85,
"ssKey": "DETECT_RTT_FLAG",
"ssValue": "1",
"note": "Is RTT detection enabled to assist in allocating rendering requests during multi region deployment",
"updateDate": "1661416311777"
},
{
"id": 90,
"ssKey": "JOYSTICK_LOGO",
"ssValue": "/images/LarkXR_joystickLogo.png?date=1690510190076",
"note": "Recommended size:254*254",
"updateDate": "1690511971545"
},
{
"id": 91,
"ssKey": "JOYSTICK_CENTER_LOGO",
"ssValue": "/images/LarkXR_joystickCenterLogo.png",
"note": "Recommended size:86*86",
"updateDate": "1679621017953"
},
{
"id": 92,
"ssKey": "CONTROLBAR_LOGO",
"ssValue": "/getCstzLogoUrl?logoType=controlBar",
"note": "Recommended size:86*86",
"updateDate": "1605801600001"
},
{
"id": 100,
"ssKey": "SEND_NOTICE",
"ssValue": "0",
"note": "After turning off offline/jitter SMS notifications, even if an offline SMS notification template is configured in the configuration file, SMS notifications will not be triggered. Attention: Please turn off this notification when the service is manually stopped",
"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"
}
]
}
Parameter Note for Success Response Example
| Field Name |
Type |
Note |
| code |
string |
None |
| message |
string |
None |
| result |
array |
None |
| id |
string |
None |
| ssKey |
string |
Key, please refer to the notes for the corresponding description of key values |
| ssValue |
string |
Please refer to the notes for the corresponding description of values and key values |
| note |
string |
explain |
| updateDate |
string |
None |
Note
5) [DISPATCH-POLICY] Allocation rules. 2: General allocation rules, 3: Suggested allocation rules.
10) Is the IP whitelist enabled. True: enabled, false: disabled.
25) [STORE-TYPE] Application storage type. 0: Local storage, 1: Minio storage, 2: Alibaba OSS, 3: Huawei OBS, 4: AWS S3.
30) Whether to enable front-end overview. 0: No, 1: Yes.
40) Whether to save VR monitoring data. 0: No, 1: Yes.
45) Storage period for VR monitoring data. Days.
50) Whether to save rendering server resource usage data. 0: No, 1: Yes.
60) [WELCOMELOGO] Launch the central logo on the page. Development version authorization can be replaced
65) [VR-CLIENT-HEADER-LOGO] The logo in the upper left corner of the VR client. The development version license can be replaced.
70) [INDEX-LOGO] Overview page logo.
75) No operation time limit (seconds).
80) [ADMIN-LOGO] Manage backend logos.
85) Whether to enable RTT detection. 0: No, 1: Yes.
90) [JOYSTICKLOGO] Disk base image.
91) [JOYSTICK-CENTER-LOGO] Button for the center of the disc.
92) Control the ball.
Whether to allow node offline/jitter SMS notifications. 0: No, 1: Yes.
105) [pxy: admin: ratelimit: startapp li]/app li/getStartInfo,/app li/getStartURL,/app li/start interface flow limit quantity.
110) [proxy: admin: ratelimit: clientinfo]/client/info interface limit the current quantity.
115) [proxy: admin: ratelimit: clientlogerr]/client/log/error interface limits the number of current flows.
120) [proxy: admin: ratelimit: reportresource]/client/reportResource interface limits the number of flows.
125) [proxy: admin: ratelimit: getrunningApplilist]/taskInfo/getRunningAppliliList interface limits the number of flows.
130) [proxy: admin: ratelimit: getrunningcnt]/taskInfo/getRunningCnt interface limits the number of flows.
135) [proxy: admin: ratelimit: getruncntandservercnt]/taskInfo/getRunCntAndServerCnt interface limit the number of current limits.
140) [pxy: admin: ratelimit: clientstarted]/taskInfo/clientStarted interface limit the current quantity.