Request URL
{{adminHost:8181}}/client/getResUsage
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] |
Request Query Parameters
| Field Name |
Sample |
Required |
Type |
Note |
| groupId |
|
No |
string |
groupId |
| page |
|
No |
string |
Page number, default to 1 |
| pageSize |
|
No |
string |
How many pieces of data per page, default to 8 |
Success Response Example
{
"code": 1000,
"message": "Success",
"result": {
"records": [
{
"clientId": 10007,
"clientIp": "175.162.5.49",
"clientName": "",
"clientMac": "2C4D79ECD6FE",
"status": 1,
"groupId": "816351359270912000",
"onlineCnt": "90",
"lastOnlineDate": "1631697818792",
"usedSeconds": "11486",
"createDate": "1603442182",
"updateDate": "1631769345236",
"taskId": "0",
"clientResUsageDto": {
"usageId": "888050528993411072",
"clientMac": "2C4D79ECD6FE",
"clientIp": "175.162.5.49",
"clientBrand": "Pico Neo 2",
"memTotal": 3687,
"memUsed": 1309,
"diskTotal": 45962,
"diskUsed": 6535,
"sdTotal": 45962,
"sdUsed": 6535,
"batteryHead": 36,
"batteryHandLeft": 80,
"batteryHandRight": 0,
"createDate": "1631769345293",
"clientId": 10007,
"status": 1
}
}
],
"total": "27",
"size": "8",
"current": "1",
"orders": [],
"searchCount": true,
"pages": "4"
}
}
Parameter Note for Success Response Example
| Field Name |
Type |
Note |
| code |
string |
None |
| message |
string |
None |
| result |
object |
None |
| records |
array |
None |
| records. clientId |
string |
Client Id |
| records. clientIp |
string |
Client IP |
| records. clientname |
string |
client name |
| records. clientMac |
string |
Client Mac |
| records. status |
string |
Client offline status 1: Online, 2: Offline |
| records. groupId |
string |
When the client is not bound to a group, it returns null. |
| records. onlineCnt |
string |
Number of online attempts |
| records. lastOnlineDate |
string |
Last online time |
| records. usedSeconds |
string |
Usage duration (in seconds) |
| records. createDate |
object |
Creation time |
| records. updateDate |
object |
Update time |
| records. taskId |
string |
Corresponding Task Id |
| records. clientResUsageDto |
object |
Client performance data object |
| records. clientResUsageDto. usageId |
string |
Client brand |
| records. clientResUsageDto. clientMac |
string |
Client Mac |
| records. clientResUsageDto. clientIp |
string |
Client IP |
| records. clientResUsageDto. clientBrand |
string |
Client brand |
| records. clientResUsageDto. memTotal |
string |
Total memory (M) |
| records. clientResUsageDto. memUsed |
string |
Memory usage (M) |
| records. clientResUsageDto. diskTotal |
string |
Disk capacity (M) |
| records. clientResUsageDto. diskUsed |
string |
Disk usage (M) |
| records. clientResUsageDto. sdTotal |
string |
Total number of storage cards (M) |
| records. clientResUsageDto. sdUsed |
string |
Memory card usage (M) |
| records. clientResUsageDto. batteryHead |
string |
The remaining power of the head mounted device (the number before the percentage) |
| records. clientResUsageDto. batteryHandLeft |
string |
Left joystick battery remaining (number before percentage) |
| records. clientResUsageDto. batteryHandRight |
string |
Right joystick battery remaining (number before percentage) |
| records. clientResUsageDto. createDate |
string |
Generation time |
| records. clientResUsageDto. clientId |
string |
Client Id |
| records. clientResUsageDto. status |
string |
Client offline status 1: Online, 2: Offline |
| total |
string |
None |
| size |
string |
None |
| current |
string |
None |
| orders |
array |
None |
| searchCount |
string |
None |
| pages |
string |
None |