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

查询KPI趋势

功能介绍

查询用户性能趋势数据。

调用方法

POST

URL

/v1/ci/enaasclient/openapi/journey/kpi/trend

表1 请求Header参数列表

名称

类型

是否必选

描述

X-Auth-Token

String

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

最小长度:0

最大长度:90000

请求Body参数

表2 请求Body参数列表

名称

类型

是否必选

描述

param

String

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

{

"startTime":"1598544000000", // 结束时间,必填项。

"endTime":"1598599020000", // 开始时间,必填项。

"userType":"journey", // 用户类型。包含journey(无线旅程)和wiredclient(有线旅程),必填项。

"trendType":"1", // 聚合类型。包含1(默认值,聚合时长是1秒钟)、0(根据查询时间范围,查询时间范围小于两小时,聚合时长是1秒钟,大于两小时是1分钟)和2(聚合时长是5分钟),必填项。

"userMac":"30-00-00-00-**-**", // 用户MAC地址,必填项。

"key":"" // 查询时间范围,可选项。

}

请求示例

POST /v1/ci/enaasclient/openapi/journey/kpi/trend HTTP/1.1
Host: example.com
Content-Type: application/json
Accept: application/json
POST /rest/v1/journey/kpi/trend HTTP/1.1Content-Type: application/json;charset=UTF8Accept: application/jsonX-Auth-Token: MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgBZQMEAgEwggIOBgkqhkiG9w0BBwGgggH--jxxA==body:{
	"startTime":"1598544000000",
	"endTime":"1598599020000",
	"userType":"journey",
	"trendType":"1",
	"userMac":"30-00-00-00-**-**",
	"key":""
}

响应参数

返回状态码为 200: 获取性能趋势数据成功。

表3 响应Body参数列表

名称

类型

是否必选

描述

resultCode

Integer

状态码。

缺省值:200

errorDes

String

错误描述。

缺省值:Successful.

errorReson

String

错误原因。

缺省值:Successful.

errorDetail

String

错误详情。

缺省值:Successful.

errorAdvice

String

错误建议。

缺省值:Successful.

data

Array of JourneyTrendModel

KPI趋势模型。

表4 JourneyTrendModel

名称

类型

是否必选

描述

startTime

Long

开始时间。

endTime

Long

结束时间。

duration

Long

周期时长。

缺省值:0

apName

String

AP名称。

pointModels

Array of JourneyPointModel

KPI模型。

表5 JourneyPointModel

名称

类型

是否必选

描述

kpiType

String

KPI指标类型。

kpiValue

Double

KPI指标值。

缺省值:0

表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
{
	  "data":{
		      "starttime":1598903602921,
		      "endtime":1598903602921,
		      "duration":123      "apname":"hw",
		      "pointmodels":[
			          {
				              "kpitype":"rssi",
				              "kpivalue":-72.30434782608695          
			},
			          {
				              "kpitype":"downLinkSpeed",
				              "kpivalue":147.7391304347826          
			},
			          {
				              "kpitype":"latency",
				              "kpivalue":509.82608695652175          
			},
			          {
				              "kpitype":"txDiscardRatio",
				              "kpivalue":3.722559807302787          
			}      
		],
		  "resultCode":200,
		  "errorDes":"Success",
		  "errorReson":"Successful.",
		  "errorDetail":"Successful.",
		  "errorAdvice":"Successful."  
	}
}

相关文档