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

查询会话列表

功能介绍

查询会话列表信息，包含开始时间、接入设备、接入类型等。

调用方法

POST

URL

/v1/ci/enaasclient/openapi/protocoltrace/sessionlist

表1 请求Header参数列表

名称

类型

是否必选

描述

X-Auth-Token

String

是

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

最小长度:0

最大长度:90000

请求Body参数

表2 请求Body参数列表

名称

类型

是否必选

描述

param

String

是

查询条件，param为JSON格式字符串，包含以下参数：

{

"intervals":"[\"2020-08-27T16:00:00.000Z/2020-08-28T06:52:21.000Z\"]", // 查询时间范围，必填项。

"level":"0", // 左树级别。站点在左侧站点树的层级，对应0-9级，0为根，必填项。

"id":"/", // 站点区域ID，“/”为根区域，必填项。

"accType":"1", // 接入类型。包含1（无线）和0（有线），必填项。

"usermac":"30-00-00-00-**-**" // 用户的MAC地址，必填项。

}

请求示例

POST /v1/ci/enaasclient/openapi/protocoltrace/sessionlist HTTP/1.1
Host: example.com
Content-Type: application/json
Accept: application/json
POST /rest/v1/protocoltrace/sessionlist HTTP/1.1Content-Type: application/json;charset=UTF8Accept: application/jsonX-Auth-Token: MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgBZQMEAgEwggIOBgkqhkiG9w0BBwGgggH--jxxA==body:{
	  "intervals":"[
		"2020-08-27T16:00:00.000Z/2020-08-28T06:52:21.000Z"
	]",
	  "level":"0",
	  "id":"/",
	  "accType":"1",
	  "usermac":"30-00-00-00-**-**"
}

响应参数

返回状态码为 200: 获取会话列表成功。

表3 响应Body参数列表

名称

类型

是否必选

描述

resultCode

Integer

否

状态码。

缺省值:200

errorDes

String

否

错误描述。

缺省值:Successful.

errorReson

String

否

错误原因。

缺省值:Successful.

errorDetail

String

否

错误详情。

缺省值:Successful.

errorAdvice

String

否

错误建议。

缺省值:Successful.

resultData

Array of SessionModel

否

会话模型。
表4 SessionModel

名称

类型

是否必选

描述

startTime

Long

否

会话开始时间。

缺省值:0

endTime

Long

否

会话结束时间。

缺省值:0

offlineTime

Long

否

离线时间。

缺省值:0

devStartTime

Long

否

会话开始设备时间。

缺省值:0

devEndTime

Long

否

会话结束设备时间。

缺省值:0

devOfflineTime

Long

否

离线设备时间。

缺省值:0

costTime

Long

否

查询时间。

缺省值:0

accessAp

String

否

接入AP的名称。

accessApMac

String

否

接入AP的MAC地址。

result

Integer

否

接入结果。

缺省值:0

errorCode

String

否

错误码。

authOfflineErrorCode

String

否

离线错误码。

ssid

String

否

SSID。

radioId

Integer

否

射频ID。

authId

String

否

会话ID。

authType

String

否

认证类型。

accessType

Integer

否

接入类型：

- 0：有线

- 1：无线

缺省值:0

lastDhcpResult

Integer

否

最后一次DHCP结果。

缺省值:-1
表5 返回状态码

返回状态码

状态码说明

响应参数

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
{
	  "resultData": [
		    {
			      "startTime": 1598903602921,
			      "endTime": 1598944449000,
			      "offlineTime": 0,
			      "costTime": 1598903602921,
			      "accessAp": "area_2",
			      "accessApMac": "1c-20-db-c9-**-**",
			      "result": 0,
			      "errorCode": null,
			      "authOfflineErrorCode": null,
			      "ssid": "Huawei-employee",
			      "radioId": 0,
			      "authId": null,
			      "authType": null,
			      "accessType": 1,
			      "lastDhcpResult": -1    
		},
		    {
			      "startTime": 1598903603461,
			      "endTime": 1598944448450,
			      "offlineTime": 0,
			      "costTime": 1592503602921,
			      "accessAp": "area_3",
			      "accessApMac": "1c-20-db-c9-**-**",
			      "result": 0,
			      "errorCode": null,
			      "authOfflineErrorCode": null,
			      "ssid": "Huawei-employee",
			      "radioId": 0,
			      "authId": null,
			      "authType": null,
			      "accessType": 1,
			      "lastDhcpResult": -1    
		}  
	],
	  "resultCode": 200,
	  "errorDes": "Success",
	  "errorReson": "Successful.",
	  "errorDetail": "Successful.",
	  "errorAdvice": "Successful."
}

父主题： 用户体验保障

相关文档