更新时间:2023-10-12 GMT+08:00
分享

查询用户物理带宽分析

功能介绍

查询Wi-Fi 6和非Wi-Fi 6设备质量看板分布。

调用方法

GET

URL

/v1/ci/enaasclient/openapi/wifi/metricdistribution/statistics

表1 请求Query参数列表

名称

类型

是否必选

描述

param

String

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

{

"portalType":"rate", // portal类型。包含latency(时延分布图)和rate(物理层宽带分布图),必填项。

"regionType":"site", // 区域类型。包含site(站点)、region(区域)、building(楼宇)和floor(楼层),必填项。

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

"showType":"wifiSix", // 展示类型。包含wifiSix(Wi-Fi 6)和nowifiSix(非Wi-Fi 6),必填项。

"startTime":"1598544000000", // 开始时间,必填项。

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

"endTime":"1598601600000", // 结束时间,必填项。

"isAutoRefresh":"false" // 接口是否自动刷新。包含false(否)和true(是),必填项。

}

表2 请求Header参数列表

名称

类型

是否必选

描述

X-Auth-Token

String

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

最小长度:0

最大长度:90000

请求参数

请求示例

GET /v1/ci/enaasclient/openapi/wifi/metricdistribution/statistics?param=null HTTP/1.1
Host: example.com
Content-Type: application/json
Accept: application/json
GET /rest/campusclientservice/v1/wifi/metricdistribution/statistics?param={
	"portalType":"rate",
	"regionType":"site",
	"level":"0",
	"showType":"wifiSix",
	"startTime":"1598544000000",
	"id":"/",
	"endTime":"1598601600000",
	"isAutoRefresh":"false"
} 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

QualityDisWifiModel

用户模式分布统计数据模型。

表4 QualityDisWifiModel

名称

类型

是否必选

描述

wifiSix

Array of Integer

Wi-Fi 6,指设备版本。

缺省值:0

noWifiSix

Array of Integer

非Wi-Fi 6,指设备版本。

缺省值:0

表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
{
	  "data": {
		    "wifiSix": [
			0,
			1,
			0,
			0,
			0,
			0,
			0,
			0,
			0
		],
		    "noWifiSix": [
			0,
			1,
			0,
			0,
			1,
			0,
			0,
			1,
			0
		]  
	},
	  "resultCode": 200,
	  "errorDes": "Success",
	  "errorReson": "Successful.",
	  "errorDetail": "Successful.",
	  "errorAdvice": "Successful."
}

相关文档