文档首页/ 华为云会议 Meeting/ 服务端API参考/ 仪表盘/ 会议QoS/ 接口参考/ 查询QoS告警阈值
更新时间：2024-08-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询QoS告警阈值

描述

该接口用于查询QoS告警阈值。仅旗舰版企业/Flexus版企业的企业管理员有权限查询。

仪表盘的QoS统计功能需要申请才能开通。请联系华为销售人员，并提供华为云会议企业ID。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/metrics/conference/threshold

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

thresholdType

是

String

Query

阈值类型。

  • AUDIO：音频告警阈值
  • VIDEO：视频告警阈值
  • SCREEN：屏幕共享告警阈值
  • CPU：CPU告警阈值

X-Access-Token

是

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

状态码

表3 状态码说明

HTTP状态码

描述

400

Bad Request 客户端传参异常。

401

Unauthorized 未鉴权或鉴权失败。

403

Forbidden 权限受限。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

latency

ThresholdData object
  • 延迟阈值信息，单位为毫秒(ms)
  • thresholdType = CPU时无效

jitter

ThresholdData object
  • 抖动阈值信息，单位为毫秒(ms)
  • thresholdType = CPU时无效

packetLoss

PacketThresholdData object
  • 丢包率阈值信息，单位为百分比(%)
  • thresholdType = CPU时无效

clientCpuMax

CPUThresholdData object
  • 会议最大CPU阈值信息，单位为百分比(%)
  • 仅当thresholdType = CPU时有效

systemCpuMax

CPUThresholdData object
  • 系统最大CPU阈值信息，单位为百分比(%)
  • 仅当thresholdType = CPU时有效
表5 ThresholdData 数据结构

参数名称

参数类型

描述

receiving

Integer

自定义接收方向阈值，单位为毫秒(ms)。

receivingDefault

Integer

默认接收方向阈值，单位为毫秒(ms)。

sending

Integer

自定义发送方向阈值，单位为毫秒(ms)。

sendingDefault

Integer

默认发送方向阈值，单位为毫秒(ms)。
表6 PacketThresholdData 数据结构

参数名称

参数类型

描述

receiving

Integer

自定义接收方向阈值，单位为百分比(%)。

receivingDefault

Integer

默认接收方向阈值，单位为百分比(%)。

sending

Integer

自定义发送方向阈值，单位为百分比(%)。

sendingDefault

Integer

默认发送方向阈值，单位为百分比(%)。
表7 CPUThresholdData 数据结构

参数名称

参数类型

描述

cpu

Integer

自定义CPU阈值，单位为百分比(%)。

cpuDefault

Integer

默认CPU阈值，单位为百分比(%)。

请求消息示例

GET /v1/metrics/conference/threshold?thresholdType=AUDIO
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例

HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 2450
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c
Server: api-gateway
X-Request-Id: ac9f75ec3c97c823f128526a924532b2
{
		"latency": {
		"receiving": 500,
		"receivingDefault": 800,
		"sending": 500,
		"sendingDefault": 800
	},
	"jitter": {
		"receiving": 500,
		"receivingDefault": 800,
		"sending": 500,
		"sendingDefault": 800
	},
	"packetLoss": {
		"receiving": 20,
		"receivingDefault": 50,
		"sending": 20,
		"sendingDefault": 50
	}
}

错误码

当您使用华为云会议服务端API时，如果遇到“MBI”开头的错误码，请参考华为云API错误中心。

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d 'thresholdType=AUDIO' https://api.meeting.huaweicloud.com/v1/metrics/conference/threshold
父主题： 接口参考

相关文档