查询与会者的QoS数据
描述
该接口用于查询企业内在线会议或历史会议的与会者QoS数据。仅旗舰版企业的企业管理员有权限查询。
仪表盘的QoS统计功能需要申请才能开通。请联系华为销售人员，并提供华为云会议企业ID。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/metrics/conference/participant/qos
请求参数
|
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
|
confUUID |
是 |
String |
Query |
会议UUID。 |
|
confType |
是 |
String |
Query |
会议类别。
|
|
participantID |
是 |
String |
Query |
与会者标识。 |
|
qosType |
是 |
String |
Query |
QoS类型
|
|
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
状态码
|
HTTP状态码 |
描述 |
|---|---|
|
400 |
Bad Request 客户端传参异常。 |
|
401 |
Unauthorized 未鉴权或鉴权失败。 |
|
403 |
Forbidden 权限受限。 |
|
500 |
服务端异常。 |
响应参数
|
参数 |
类型 |
描述 |
|---|---|---|
|
user |
QosParticipantInfo object |
与会者信息。 |
|
qos |
QosInfo object |
QoS数据。 |
|
参数名称 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
QoS类型
|
|
send |
QosSendReceiveInfo object |
会议与会者发送QoS数据。当qosType = audio/video/screen 时有效。 |
|
receive |
QosSendReceiveInfo object |
会议与会者接收QoS数据。当qosType = audio/video/screen 时有效。 |
|
cpu |
QosCpuInfo object |
会议与会者CPU QoS数据，当qosType = cpu 时有效。 |
|
参数名称 |
参数类型 |
描述 |
|---|---|---|
|
bitrate |
Array of QosDataNoThrElement objects |
码率，单位kbps，不含阈值告警。当qosType = audio/video/screen 时有效。 |
|
latency |
Array of QosDataElement objects |
时延，单位毫秒, 含阈值告警。当qosType = audio/video/screen 时有效。 |
|
jitter |
Array of QosDataElement objects |
抖动，单位毫秒，含阈值告警。当qosType = audio/video/screen 时有效。 |
|
packet_loss_max |
Array of QosDataElement objects |
最大丢包率，单位百分比 含阈值告警。当qosType = audio/video/screen 时有效。 |
|
resolution |
Array of QosDataNoThrElement objects |
分辨率，不含阈值告警。当qosType = video/screen 时有效。 |
|
frame |
Array of QosDataNoThrElement objects |
帧率，单位fps，不含阈值告警。当qosType = video/screen 时有效。 |
|
参数名称 |
参数类型 |
描述 |
|---|---|---|
|
client_cpu_max |
Array of QosDataElement objects |
App最大CPU使用率。 |
|
system_cpu_max |
Array of QosDataElement objects |
系统最大CPU使用率。 |
请求消息示例
GET /v1/metrics/conference/participant/qos?confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history&participantID=kxxwoo5hmo9khlmggklawbwiwfl999bw&qosType=video 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
{
"user": {
"confUUID": "a3d9a31c8af211eb8075a12479434adb",
"conferenceID": "98909587",
"participantID": "kxxwoo5hmo9khlmggklawbwiwfl999bw",
"userUUID": "ff80808167ef1edf0167f339533d05a6",
"displayName": "深圳分部",
"deptName": "XXXXX",
"terminalType": "PC",
"role": "host",
"ipAddress": "***.***.**.**",
"country": "中国",
"province": "四川省",
"city": "成都市",
"appVersion": "60.15.5",
"joinTime": 1618220940926,
"leftTime": 1618221194202,
"systemInfo": "android-11",
"networkType": "wifi",
"alarm": "YES",
"audioAlarmSend": "YES",
"videoAlarmSend": "NO",
"screenAlarmSend": "NO",
"audioAlarmRec": "YES",
"videoAlarmRec": "YES",
"screenAlarmRec": "NO",
"cpuAlarm": "NO",
"microphoneInfo": "Microphone Array (Realtek(R) Audio)",
"speakerInfo": "Speakers/Headphones (Realtek(R) Audio)",
"cameraInfo": "Lenovo EasyCamera",
"dataCenter": "Region-China-2",
"leftReason": 0
},
"qos": {
"type": "video",
"send": {
"bitrate": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000
}],
"latency": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000,
"alarm": true,
"threshold": 700
}],
"jitter": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000,
"alarm": true,
"threshold": 700
}],
"packet_loss_max": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000,
"alarm": true,
"threshold": 700
}],
"resolution": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000
}],
"frame": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000
}]
},
"receive": {
"bitrate": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000
}],
"latency": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000,
"alarm": true,
"threshold": 700
}],
"jitter": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000,
"alarm": true,
"threshold": 700
}],
"packet_loss_max": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000,
"alarm": true,
"threshold": 700
}],
"resolution": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000
}],
"frame": [{
"time": "2021-04-16T01:18:23.404Z",
"value": 1000
}]
}
}
}
错误码
当您使用华为云会议服务端API时，如果遇到“MBI”开头的错误码，请参考华为云API错误中心。
CURL命令示例
curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d 'confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history&participantId=kxxwoo5hmo9khlmggklawbwiwfl999bw&qosType=video' https://api.meeting.huaweicloud.com/v1/metrics/conference/participant/qos
