简要描述
请求URL
{{adminHost:8181}}/group/search
请求方式
字段名 |
示例值 |
必选 |
类型 |
说明 |
adminKey |
603284317954637824 |
是 |
string |
该参数为后台管理接入凭证,在LarkXR3.3后台接入管理中查看 |
timestamp |
8641706679604867 |
是 |
string |
发送请求时的时间戳,单位为毫秒 |
signature |
9A02B47AE67664D80A2ED13FC2B1691512613790 |
是 |
string |
该参数为密钥签名。将adminKey(LarkXR3.2后台接入管理中查看)和adminSecret(LarkXR3.3后台中接入管理查看)和当前时间戳(long型数值)按字母序排序,然后进行SHA-1摘要签名。请参考【获取凭证签名】的样例 |
请求Query参数
参数名 |
示例值 |
必选 |
类型 |
说明 |
groupId |
|
是 |
long |
分组ID |
groupName |
|
是 |
string |
无 |
wsId |
|
是 |
string |
无 |
page |
|
是 |
int |
无 |
pageSize |
|
是 |
int |
无 |
成功返回示例
{
"code": 1000,
"message": "Success",
"result": {
"records": [
{
"groupId": "601477834145267712",
"groupName": "Default",
"clientRunMode": 0,
"noOperationTimeout": "0",
"createDate": "20190722132708",
"updateDate": "1687939292630"
},
{
"groupId": "1194226279482654720",
"groupName": "test",
"clientRunMode": 1,
"noOperationTimeout": "0",
"wsId": "6mLkDgqf",
"createDate": "1704767332681",
"updateDate": "1704767332682",
"clientRunModeName": "自主切换",
"wsName": "pxydev-overseas-xuzhibin123"
}
],
"total": "2",
"size": "15",
"current": "1",
"orders": [],
"optimizeCountSql": true,
"searchCount": true,
"pages": "1"
}
}
成功返回示例的参数说明
参数名 |
类型 |
说明 |
code |
string |
无 |
message |
string |
无 |
result |
object |
无 |
records |
array |
无 |
records.groupId |
string |
组别Id |
records.groupName |
string |
组别名称 |
records.clientRunMode |
string |
VR客户端运行模式:1:自主切换,2:集中管控 ,3:演示模式 |
records.noOperationTimeout |
string |
无操作超时时间,0表示不超时。 |
primaryClientId |
string |
VR主控端眼镜,用于演示模式时,选择一个作为主控眼镜进行操作,其余眼镜观看 |
records.createDate |
string |
创建时间 |
records.updateDate |
string |
更新时间 |
total |
string |
共计多少条数据 |
size |
string |
每页多少条数据 |
current |
string |
当前页码 |
pages |
string |
一共有多少页 |
备注