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

设置QoS告警阈值

描述

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

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

调试

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

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/metrics/conference/threshold

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

thresholdType

是

String

Query

阈值类型。

  • AUDIO：音频相关阈值
  • VIDEO：视频相关阈值
  • SCREEN：屏幕共享相关阈值
  • CPU：CPU相关阈值

X-Access-Token

是

String

Header

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

latency

否

SetThresholdData object

Body
  • 延迟阈值设置值，单位为毫秒(ms)
  • thresholdType = AUDIO/VIDEO/SCREEN时必填
  • thresholdType = CPU时无效

jitter

否

SetThresholdData object

Body
  • 抖动阈值设置值，单位为毫秒(ms)
  • thresholdType = AUDIO/VIDEO/SCREEN时必填
  • thresholdType = CPU时无效

packetLoss

否

SetPacketThresholdData object

Body
  • 丢包率阈值设置值，单位为百分比(%)
  • thresholdType = AUDIO/VIDEO/SCREEN时必填
  • thresholdType = CPU时无效

clientCpuMax

否

SetCPUThresholdData object

Body
  • 会议最大CPU阈值设置值，单位为百分比(%)
  • thresholdType = AUDIO/VIDEO/SCREEN时无效
  • thresholdType = CPU时必填

systemCpuMax

否

SetCPUThresholdData object

Body
  • 系统最大CPU阈值设置值，单位为百分比(%)
  • thresholdType = AUDIO/VIDEO/SCREEN时无效
  • thresholdType = CPU时必填
表3 SetThresholdData 数据结构

参数名称

参数类型

描述

receiving

Integer

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

取值范围：0 - 10000。

sending

Integer

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

取值范围：0 - 10000。
表4 SetPacketThresholdData 数据结构

参数名称

参数类型

描述

receiving

Integer

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

取值范围：0 - 100。

sending

Integer

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

取值范围：0 - 100。
表5 SetCPUThresholdData 数据结构

参数名称

参数类型

描述

cpu

Integer

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

取值范围：0 - 100。

状态码

表6 状态码说明

HTTP状态码

描述

400

Bad Request 客户端传参异常。

401

Unauthorized 未鉴权或鉴权失败。

403

Forbidden 权限受限。

500

服务端异常。

响应参数

表7 响应参数

参数

类型

描述

code

String

返回码。

message

String

返回信息。

请求消息示例

POST /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)

{
	"latency": {
		"receiving": 500,
		"sending": 500
	},
	"jitter": {
		"receiving": 500,
		"sending": 500
	},
	"packetLoss": {
		"receiving": 20,
		"sending": 20
	}
}

响应消息示例

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
{
	"code": "0",
	"message": "OK"
}

错误码

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

CURL命令示例

curl -k -i -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d 'thresholdType=AUDIO' https://api.meeting.huaweicloud.com/v1/metrics/conference/threshold -d'{"latency":{"receiving":500,"sending":500},"jitter":{"receiving":500,"sending":500},"packetLoss":{"receiving":20,"sending":20}}'
父主题： 接口参考

相关文档