文档首页/ 华为乾坤/ 云管理网络/ API参考/ 接口参考/ 网络环境监控/ 查询无线健康度单个维度数据统计
更新时间：2023-09-04 GMT+08:00
查看PDF
分享

查询无线健康度单个维度数据统计

功能介绍

查询无线健康度单个维度数据统计，根据指标类型查询该指标下的各子指标数据统计。

调用方法

GET

URL

/v1/ci/expmonitor/common/basic

表1 请求Query参数列表

名称

类型

是否必选

描述

param

String

是

查询条件，param格式：

{

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

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

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

"tenantId": "default-organization-id", // 租户ID，必填项。

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

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

"settingRefresh": false, // 是否自动刷新。包含false(否)和true(是)，默认为false。

"metricType": "accessSuccessRate" // 指标类型。包含accessSuccessRate（接入成功率）、accessConsume（接入耗时）、roam（漫游达标率）、coverage（信号与干扰）、capacity（容量健康度）和throughput（吞吐达标率）类型，必填项。

}

最小长度:1

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

名称

类型

是否必选

描述

X-Auth-Token

String

是

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

最小长度:0

最大长度:90000

请求Body参数

无

请求示例

GET /v1/ci/expmonitor/common/basic?param={id:/,regionType:site,level:0,tenantId:default-organization-id,startTime:1597766400000,endTime:1597820400000,settingRefresh:false,metricType:accessSuccessRate} HTTP/1.1
Host: example.com
Content-Type: application/json
Accept: application/json
X-Auth-Token: MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgBZQMEAgEwggIOBgkqhkiG9w0BBwGgggH--jxxA==

响应参数

返回状态码为 200: query metric data

表3 响应Body参数列表

名称

类型

是否必选

描述

resultCode

Integer

否

状态码。

缺省值:200

errorDes

String

否

错误描述。

缺省值:Successful.

errorReson

String

否

错误原因。

缺省值:Successful.

errorDetail

String

否

错误详情。

缺省值:Successful.

errorAdvice

String

否

错误建议。

缺省值:Successful.

data

MetricDataModel

否

无线健康度单个维度数据统计。
表4 MetricDataModel

名称

类型

是否必选

描述

rootValue

Double

否

单个维度总指标值。

缺省值:-1.0

最小数值:-1.0

最大数值:100.0

rank

Integer

否

维度值排名。

缺省值:0

rankList

Array of MetricRankModel

否

各区域值集合。

subValues

Array of KeyValueModel

否

子维度值集合。
表5 MetricRankModel

名称

类型

是否必选

描述

regionId

String

否

区域ID。

最小长度:0

最大长度:64

regionName

String

否

区域名。

最小长度:0

最大长度:64

value

Double

否

单个区域维度数据。

缺省值:-1.0

最小数值:-1.0

最大数值:100.0
表6 KeyValueModel

名称

类型

是否必选

描述

key

String

否

子维度：

- 当维度为accessSuccessRate时，子维度包含association（关联成功率）、authentication（认证成功率）和dhcp（DHCP成功率）。

- 当维度为accessConsume时，子维度包含association（关联耗时）、authentication（认证耗时）和dhcp（DHCP耗时）。

- 当维度为roam时，子维度包含roamSucc（漫游成功率）、roamTimeCost（漫游耗时）和roamRssi（漫游前信号强度）。

- 当维度为coverage时，子维度包含rssi（信号强度达标率）和interference（干扰达标率）。

- 当维度为capacity时，子维度包含channelUsage（信道利用率达标率）和userCount（用户数达标率）。

- 当维度为throughput时，子维度包含nonfiveg（非5G优先占比）、avgrate（带宽）和congestion（空口拥塞达标率）。

最小长度:0

最大长度:32

value

String

否

子维度数据。

最小长度:0

最大长度:32
表7 返回状态码

返回状态码

状态码说明

响应参数

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":{
		"rootValue":23.1,
		"rank":1,
		"rankList":[
			{
				"regionId":"df6d6509-894b-40f3-9ab0-a0bd01554272",
				"regionName":"string",
				"value":33.2
			}
		],
		"subValues":[
			{
				"key":"authentication",
				"value":"52.1"
			}
		]
	}
}
父主题： 网络环境监控

相关文档