查询QoS在线会议列表
描述
该接口用于查询企业内正在召开会议的QoS告警。仅旗舰版企业/标准版企业的企业管理员有权限查询。
仪表盘的QoS统计功能需要申请才能开通。请联系华为销售人员，并提供华为云会议企业ID。
调试
您可以在API Explorer中调试该接口。
接口原型
请求方法 |
GET |
|---|---|
请求地址 |
/v1/metrics/conferences/online |
传输协议 |
HTTPS |
请求参数
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
offset |
否 |
Integer |
Query |
查询偏移量。
|
limit |
否 |
Integer |
Query |
查询的条目数量。
|
searchKey |
否 |
String |
Query |
查询条件。会议主题、会议预约人和会议ID等可作为搜索内容。长度限制为1-512个字符。 |
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
状态码
HTTP状态码 |
描述 |
|---|---|
400 |
Bad Request 客户端传参异常。 |
401 |
Unauthorized 未鉴权或鉴权失败。 |
403 |
Forbidden 权限受限。 |
500 |
服务端异常。 |
响应参数
参数 |
类型 |
描述 |
|---|---|---|
count |
Integer |
总记录数。 |
limit |
Integer |
查询条目数量。 |
offset |
Integer |
查询偏移量。 |
data |
Array of QosConferenceInfo objects |
QoS在线会议列表，按照会议开始时间降序排序。 |
参数名称 |
参数类型 |
描述 |
|---|---|---|
confUUID |
String |
会议UUID。 |
conferenceID |
String |
会议ID。 |
subject |
String |
会议主题。 |
scheduserName |
String |
会议预订者名称。 |
deptName |
String |
部门名称。 |
alarm |
String |
总体告警 。
|
audioAlarm |
String |
音频告警 。
|
videoAlarm |
String |
视频告警 。
|
screenAlarm |
String |
屏幕共享告警。
|
cpuAlarm |
String |
CPU告警。
|
timeZoneID |
String |
会议通知中会议时间的时区信息。时区信息，参考时区映射关系。
说明：
举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 |
startTime |
Long |
会议开始时间(UTC时间), Unix时间戳（单位毫秒）。 |
endTime |
Long |
会议结束时间(UTC时间), Unix时间戳（单位毫秒）。
说明：
|
duration |
Integer |
会议召开时长（分钟）。
说明：
|
participants |
Integer |
与会方数。
说明：
同一用户多次进出会议属于不同的与会方，与会方数则计算多次。 |
webinar |
Boolean |
是否是网络研讨会。 |
请求消息示例
GET /v1/metrics/conferences/online?offset=0&limit=20&searchKey=深圳分部 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
{
"count": 1,
"limit": 10,
"offset": 0,
"data": [{
"confUUID": "a3d9a31c8af211eb8075a12479434adb",
"conferenceID": "98909587",
"subject": "研发晨会",
"scheduserName": "深圳分部秘书",
"deptName": "XXXXX",
"alarm": "YES",
"audioAlarm": "NO",
"videoAlarm": "YES",
"screenAlarm": "NO",
"cpuAlarm": "NO",
"timeZoneID": "56",
"startTime": 1618220740926,
"endTime": 1618222194202,
"duration": 32,
"participants": 52,
"webinar": false
}]
}
错误码
当您使用华为云会议服务端API时，如果遇到“MBI”开头的错误码，请参考华为云API错误中心。
CURL命令示例
curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' https://api.meeting.huaweicloud.com/v1/metrics/conferences/online
