Request URL
{{adminHost:8181}}/client/search
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 |
clientId |
|
No |
string |
clientId |
clientMac |
|
No |
string |
clientMac |
clientIp |
|
No |
string |
clientIp |
status |
|
No |
string |
Client online and offline status 1: online, 2: offline |
groupId |
|
No |
string |
groupId |
page |
|
No |
string |
Page number, default to 1 |
pageSize |
|
No |
string |
How many pieces of data are there on each page, default to 16 |
Success Response Example
{
"code": 1000,
"message": "操作成功",
"result": {
"records": [
{
"id": "716985215234342912",
"clientId": "C1002",
"clientIp": "36.128.128.230",
"clientMac": "2C2617508428",
"clientName": "Quest",
"status": "2",
"groupId": "727171602550095872",
"onlineCnt": "37",
"lastOnlineDate": "1593739782000",
"usedSeconds": "19840",
"createDate": null,
"updateDate": null,
"vrAppliId": null,
"vrAppliName": null,
"taskId": "0",
"serverIp": null,
"groupName": "test"
}
]
}
}
Note