更新时间:2024-10-11 GMT+08:00
分享

查询QoS历史会议列表

描述

该接口用于查询企业内历史会议的QoS告警。仅旗舰版企业的企业管理员有权限查询。可以查询最近45天内的数据。

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

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/metrics/conferences/history

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

startDate

Long

Query

查询的起始日期,Unix时间戳(单位毫秒)。

endDate

Long

Query

查询的截止日期,Unix时间戳(单位毫秒)。

offset

Integer

Query

查询偏移量。

  • 取值:大于等于0,默认值为0
  • 大于等于最大条目数量,则返回最后一页的数据

limit

Integer

Query

查询的条目数量。

  • 取值:1-500,默认值为20

searchKey

String

Query

查询条件。会议主题、会议预约人和会议ID等可作为搜索内容。长度限制为1-512个字符。

X-Access-Token

String

Header

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

状态码

表3 状态码说明

HTTP状态码

描述

400

Bad Request 客户端传参异常。

401

Unauthorized 未鉴权或鉴权失败。

403

Forbidden 权限受限。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

count

Integer

总记录数。

limit

Integer

查询条目数量。

offset

Integer

查询偏移量。

data

Array of QosConferenceInfo objects

QoS历史会议列表,按照会议开始时间降序排序。最多返回500条记录。

请求消息示例

GET​ /v1/metrics/conferences/history?startDate=1617206400000&endDate=1618588800000&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' -d 'startDate=1617206400000&endDate=1618588800000' https://api.meeting.huaweicloud.com/v1/metrics/conferences/history

相关文档