本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本。
在实时音视频通话场景中,你可以通过调用此接口查询指定时间段内某个应用的音视频通话离线质量指标数据。
若要查询地域分布、设备平台、网络类型等维度的离线质量数据,建议调用 ListQualityDistribution 接口。
你可以调用 ListQuality
接口,指定你所属的 AppId
,指标类型和查询时间段,查询该时间段内指标的数据。
最大请求次数:2次/秒
最远可查询时间:30 天
最大单次查询时间跨度:7 天
数据粒度:1 天 或 5 分钟
数据延迟:8 小时
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListQuality | 接口名称。当前 API 的名称为 ListQuality 。 |
Version | String | 是 | 2023-11-01 | 接口版本。当前 API 的版本为 2023-11-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
AppId | String | 是 | 661e****543cf | 你的音视频应用的唯一标志,参看获取 AppId。 |
StartTime | String | 是 | 2021-07-24T00:00:00+08:00 | 查询起始时间戳,格式为 RFC3339,单位为秒。 |
EndTime | String | 是 | 2021-07-28T00:00:00+08:00 | 查询结束时间戳,格式为 RFC3339,单位为秒。 |
Indicator | String[] | 是 | ["stall_rate","join_room_success_rate"] | 查询的指标名称。可同时查询多个指标。Indicator 可选值,参看质量数据相关 indicator。 |
AggregateGranularity | String | 是 | 1d | 返回聚合时间的粒度,支持取值及含义如下:
|
OS | String[] | 否 | ["ios","linux"] | 枚举值为: ProductType = web 时该参数不生效 |
Access | String[] | 否 | ["2g","3g"] | 网络类型,枚举值为: 2g 、3g 、4g 、5g 、wifi ProductType = web 时该参数不生效 |
RoomId | String | 否 | Room1 | 房间 ID。如果不填,代表查询该 AppId 的整体离线指标。 |
UserId | String[] | 否 | User1 | 查询的用户 ID 列表,最多可以指定 20 个。值不合法时默认剔除。此字段仅在 RoomId 不为空时生效。 |
ProductType | String | 否 | native | 要查询的产品类型,支持取值及含义如下:
native |
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AggregateGranularity | String | 1d | 返回数据的粒度 |
Indicators | Object[] | AudioStallDuration | 具体指标数据 |
Data | Object[] | - | 具体的指标值以及对应时间 |
Value | Double | 99.99 | 指标值,浮点数,保留两位小数。指标值,浮点数,保留两位小数。 |
TimeStamp | String | 2021-07-24T00:00:00+08:00 | 指标聚合时间,即指标值对应时间段的开始时刻(每 30s 一聚合)。格式为 RFC3339 规范。指标聚合时间,即指标值对应时间段的开始时刻(每 30s 一聚合)。格式为 RFC3339 规范。 |
Name | String | 5s_join_room_success_rate | 指标名称 |
Unit | String | % | 指标单位 |
POST https://rtc.volcengineapi.com?Action=ListQuality&Version=2023-11-01 { "AppId" : "661e****543cf", "StartTime" : "2021-07-24T00:00:00+08:00", "EndTime" : "2021-07-28T00:00:00+08:00", "Indicator": ["stall_rate","join_room_success_rate"], "ProductType": "native", "AggregateGranularity": "1d", "OS": ["ios","linux"], "Access": ["2g","3g"], "RoomId": "Room1", "UserId": "user1" }
{ "ResponseMetadata": { "RequestId": "20230****10420", "Action": "ListQuality", "Version": "2023-11-01", "Service": "rtc", "Region": "cn-north-1" }, "Result": { "AggregateGranularity": "1d", "Indicators": [ { "Name": "5s_join_room_success_rate", "Unit": "%", "Data": [ { "TimeStamp": "2021-07-24T00:00:00+08:00", "Value": 98.68 }, { "TimeStamp": "2021-07-25T00:00:00+08:00", "Value": 98.2 } ] }, { "Name": "10s_join_room_success_rate", "Unit": "%", "Data": [ { "TimeStamp": "2021-07-24T00:00:00+08:00", "Value": 99.68 }, { "TimeStamp": "2021-07-25T00:00:00+08:00", "Value": 99.2 } ] } ] } }