简要描述
请求URL
{{adminHost:8181}}/client/search
请求方式
| 字段名 |
示例值 |
必选 |
类型 |
说明 |
| adminKey |
603284317954637824 |
是 |
string |
该参数为后台管理接入凭证，在LarkXR3.3后台接入管理中查看 |
| timestamp |
8641706679604867 |
是 |
string |
发送请求时的时间戳，单位为毫秒 |
| signature |
9A02B47AE67664D80A2ED13FC2B1691512613790 |
是 |
string |
该参数为密钥签名。将adminKey（LarkXR3.3后台接入管理中查看）和adminSecret（LarkXR3.3后台中接入管理查看）和当前时间戳（long型数值）按字母序排序，然后进行SHA-1摘要签名。请参考【获取凭证签名】的样例 |
请求Query参数
| 参数名 |
示例值 |
必选 |
类型 |
说明 |
| clientId |
|
否 |
string |
客户端Id |
| clientMac |
|
否 |
string |
客户端Mac |
| clientIp |
|
否 |
string |
客户端Ip |
| status |
|
否 |
string |
客户端上下线状态 1：上线，2：下线 |
| groupId |
|
否 |
string |
组别Id |
| page |
|
否 |
string |
页码，默认为1 |
| pageSize |
|
否 |
string |
每页多少条数据，默认为16 |
成功返回示例
{
"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"
}
]
}
}
成功返回示例的参数说明
| 参数名 |
类型 |
说明 |
| code |
string |
无 |
| message |
string |
无 |
| result |
object |
无 |
| records |
array |
无 |
| records.id |
string |
无 |
| records.clientId |
string |
客户端Id |
| records.clientIp |
string |
客户端Ip |
| records.clientMac |
string |
客户端Mac |
| records.clientName |
string |
客户端名称 |
| records.status |
string |
客户端上下线状态 1：上线，2：下线 |
| records.groupId |
string |
客户端没有绑定组别时，返回是null |
| records.groupName |
string |
客户端没有绑定组别时，返回是null |
| records.onlineCnt |
string |
上线次数 |
| records.lastOnlineDate |
string |
最后一次的上线时间 |
| records.usedSeconds |
string |
使用时长（单位：s） |
| records.createDate |
object |
创建时间 |
| records.updateDate |
object |
更新时间 |
| records.vrAppliId |
object |
运行的应用Id |
| records.vrAppliName |
object |
运行的应用名称 |
| records.taskId |
string |
对应的任务Id |
| records.serverIp |
object |
分配到的服务器Ip |
备注
