查询用户列表
功能介绍
查询用户列表，获取用户MAC、用户名、质差时长、接入类型、总流量等。
调用方法
POST
URL
/v1/ci/enaasclient/openapi/event/userlist
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
X-Auth-Token |
String |
是 |
认证Token，用于API的Token认证。 最小长度:0 最大长度:90000 |
请求Body参数
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
param |
String |
是 |
查询条件，param为JSON格式字符串，包含以下参数： { "filter":"[{\"operate\":\"=\",\"value\":\"0\",\"key\":\"accType\"}]", // 查询筛选条件，必填项。 "currPage":"1", // 当前页，必填项。 "sortColumn":"totalcount", // 排序列。包含totalcount（总体验时长）、rssi（平均RSSI）、rateAvg（平均下行速率）、totalBytes（总流量）、latency（时延）和packetloss（丢包率），必填项。 "pageSize":"20", // 每页记录数，必填项。 "startTime":1599494400000, // 开始时间，必填项。 "endTime":1599551433000, // 结束时间，必填项。 "id":"/", // 站点区域ID，“/”为根区域，必填项。 "level":0, //站点层级，0：全局（默认），1：具体站点，必填项。 "sortType":"desc" // 排序类型。包含desc（降序）和asc（升序），必填项。 } |
请求示例
POST /v1/ci/enaasclient/openapi/event/userlist HTTP/1.1
Host: example.com
Content-Type: application/json
Accept: application/json
POST /rest/v1/event/userlist HTTP/1.1Content-Type: application/json;charset=UTF8Accept: application/jsonX-Auth-Token: MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgBZQMEAgEwggIOBgkqhkiG9w0BBwGgggH--jxxA==body:{
"filter":"[
{
\"operate\":\"=\",
\"value\":\"0\",
\"key\":\"accType\"
}
]",
"sortColumn":"totalcount",
"currPage":"1",
"sortType":"desc",
"level":"0",
"pageSize":"20",
"startTime":"1598544000000",
"endTime":"1598596169000",
"id":"/"
}
响应参数
返回状态码为 200: 获取用户列表成功。
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
resultCode |
Integer |
否 |
状态码。 缺省值:200 |
errorDes |
String |
否 |
错误描述。 缺省值:Successful. |
errorReson |
String |
否 |
错误原因。 缺省值:Successful. |
errorDetail |
String |
否 |
错误详情。 缺省值:Successful. |
errorAdvice |
String |
否 |
错误建议。 缺省值:Successful. |
data |
否 |
用户结果集。 |
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
totalSize |
Integer |
否 |
总数。 |
pageSize |
Integer |
否 |
页数。 |
tableData |
Array of EventUserModel |
否 |
单用户模型。 |
名称 |
类型 |
是否必选 |
描述 |
|---|---|---|---|
userMac |
String |
否 |
用户MAC。 |
userName |
String |
否 |
用户名。 |
userMac |
String |
否 |
用户MAC。 |
userName |
String |
否 |
用户名。 |
userIp |
String |
否 |
用户IP。 |
vipType |
Long |
否 |
VIP类型： - 1：VIP - 0：非VIP 缺省值:0 |
accessType |
Long |
否 |
接入类型： - 1：有线 - 0：无线 缺省值:1 |
lastJoinRes |
Integer |
否 |
最近接入结果： - 1：成功 - 0：失败 缺省值:-1 |
totalTimes |
Long |
否 |
总体验时长。 缺省值:0 |
worseTimes |
Long |
否 |
质差次数。 缺省值:0 |
joinFailTimes |
Long |
否 |
接入失败次数。 缺省值:0 |
rssiAvg |
Long |
否 |
平均RSSI。 缺省值:0 |
rateAvg |
Long |
否 |
平均速率。 缺省值:0 |
snrAvg |
Long |
否 |
平均信噪比。 缺省值:0 |
totalBytes |
Long |
否 |
总流量。 缺省值:0 |
joinTotalTimes |
Long |
否 |
总接入次数。 缺省值:0 |
joinCostTimeAvg |
Long |
否 |
平均接入耗时。 缺省值:0 |
userType |
String |
否 |
用户类型。 |
dualFrequency |
Integer |
否 |
终端能力。 缺省值:0 |
vendor |
String |
否 |
设备厂商。 |
apName |
String |
否 |
AP的名称。 |
apMac |
String |
否 |
AP的MAC地址。 |
band |
Integer |
否 |
频段。 缺省值:0 |
accTime |
Long |
否 |
接入时间。 缺省值:0 |
vipflag |
String |
否 |
设置VIP是否成功： - 1：成功 - 0：失败 |
latency |
Double |
否 |
时延。 缺省值:0 |
packetloss |
Long |
否 |
丢包率。 缺省值:0 |
totalPoorTimes |
Long |
否 |
质差总时长。 缺省值:0 |
minAccTime |
Long |
否 |
第一次接入时间。 缺省值:0 |
roamingSuccTimes |
Long |
否 |
漫游成功次数。 缺省值:0 |
roamingTotalTimes |
Long |
否 |
漫游总次数。 缺省值:0 |
linkQuality |
Double |
否 |
链路质量。 缺省值:0.0 |
privacyStaType |
Long |
否 |
是否隐私用户： - 1：隐私用户 - 0：非隐私用户 缺省值:0 |
upExpAvg |
Long |
否 |
上行体验速率。 缺省值:0 |
downExpAvg |
Long |
否 |
下行体验速率。 缺省值:0 |
stickyTag |
Long |
否 |
粘性终端百分比。 缺省值:0 |
experienceScore |
Double |
否 |
用户体验评分。 缺省值:0 |
返回状态码 |
状态码说明 |
响应参数 |
|---|---|---|
400 |
参数错误 |
无 |
401 |
该用户未认证 |
无 |
403 |
URL鉴权失败 |
无 |
404 |
REST接口没找到 |
无 |
500 |
服务器内部错误 |
无 |
502 |
网关错误 |
无 |
503 |
服务不可用 |
无 |
响应示例
HTTP/1.1 200 OK Data:Tue,26 Jul 2022 17:31:54 GMT Server: example.com Content-Type: application/json
{
"resultCode": 200,
"errorDes": "Success",
"errorReson": "Successful.",
"errorDetail": "Successful.",
"errorAdvice": "Successful." "totalSize": 255,
"pageSize": 20,
"tableData": [
{
"userMac": "cc-bb-fe-1e-**-**",
"userName": "1200000",
"vipType": 0,
"accessType": 1,
"lastJoinRes": 1,
"totalTimes": 13380,
"worseTimes": 0,
"joinFailTimes": 0,
"rssiAvg": -75,
"rateAvg": 2466,
"snrAvg": 0,
"totalBytes": 19803833,
"joinTotalTimes": 0,
"joinCostTimeAvg": 0,
"userType": null,
"dualFrequency": 0,
"vendor": "HUAWEI TECHNOLOGIES CO.,
LTD",
"apName": null,
"apMac": null,
"band": 0,
"accTime": 0,
"vipflag": null,
"latency": 506,
"packetloss": 3,
"totalPoorTimes": 480,
"minAccTime": 1598904000000,
"roamingSuccTimes": 0,
"roamingTotalTimes": 0,
"linkQuality": 0.5062716403858125
}
]
}
