文档首页/ 华为乾坤/ 云管理网络/ API参考/ 接口参考/ 用户体验保障/ 查询用户会话信息
更新时间：2023-09-04 GMT+08:00
查看PDF
分享

查询用户会话信息

功能介绍

查询用户会话信息，包括用户信息、会话开始时间、接入时长和设备信息等。

调用方法

GET

URL

/v1/ci/enaasclient/openapi/client/sessions
表1 请求Query参数列表

名称

类型

是否必选

描述

param

String

是

查询条件，param格式：

{"param":

{"siteId":"", // 站点区域ID，如果不设置该参数，默认查询所有站点。

"userMac":"",//用户MAC，查询该用户的会话信息。如果不设置该参数，默认查询所有用户会话信息。

"userIp":"", //用户IP，查询该用户的会话信息。如果不设置该参数，默认查询所有用户会话信息。

"userName":"",// 用户名，查询该用户的会话信息。如果不设置该参数，默认查询所有用户会话信息。

"startTime":"1607508000000",// 查询会话的开始时间，必填项。

"endTime":"1607511600000"// 查询会话的结束时间，必填项。查询间隔需大于1小时。}

}

最大长度:90000
表2 请求Header参数列表

名称

类型

是否必选

描述

X-Auth-Token

String

是

认证Token，用于API的Token认证。

最小长度:0

最大长度:90000

请求Body参数

无

请求示例

GET /v1/ci/enaasclient/openapi/client/sessions?param=null HTTP/1.1
Host: example.com
Content-Type: application/json
Accept: application/json
GET /rest/campusclientservice/v1/client/sessions?param={
	"startTime":"1607508000000",
	"endTime":"1607511600000"
} HTTP/1.1Content-Type: application/json;charset=UTF8Accept: application/jsonX-Auth-Token: MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgBZQMEAgEwggIOBgkqhkiG9w0BBwGgggH--jxxA==

响应参数

返回状态码为 200: 获取用户信息成功。

表3 响应Body参数列表

名称

类型

是否必选

描述

resultCode

Integer

否

状态码。

缺省值:200

errorDes

String

否

错误描述。

缺省值:Successful.

errorReson

String

否

错误原因。

缺省值:Successful.

errorDetail

String

否

错误详情。

缺省值:Successful.

errorAdvice

String

否

错误建议。

缺省值:Successful.

data

Array of ClientSession

否

用户会话信息。
表4 ClientSession

名称

类型

是否必选

描述

userMac

String

否

用户MAC。

userName

String

否

用户名。

sessions

Array of SessionInfo

否

会话模型。
表5 SessionInfo

名称

类型

是否必选

描述

time

Long

否

会话开始时间。

缺省值:0L

onlineTime

Long

否

会话持续时间，单位秒。

缺省值:0L

devMac

String

否

接入设备MAC。

devName

String

否

接入设备名称。

radioId

String

否

射频ID。

ssid

String

否

接入SSID。

userIp

String

否

IP地址。
表6 返回状态码

返回状态码

状态码说明

响应参数

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":"Successful.",
	"errorReson":"Successful.",
	"errorDetail":"Successful.",
	"errorAdvice":"Successful.",
	"data":[
		{
			"userMac":"string",
			"userName":"string",
			"sessions":[
				{
					"time":"integer",
					"onlineTime":"integer",
					"devMac":"string",
					"devName":"string",
					"radioId":"string",
					"ssid":"string",
					"userIp":"string"
				}
			]
		}
	]
}
父主题： 用户体验保障

相关文档