You need to enable JavaScript to run this app.
导航

获取实时质量数据 ListRealTimeQuality

最近更新时间2024.01.12 16:39:43

首次发布时间2022.07.08 11:35:38

你可以使用此接口查询一段时间内,某个应用的音视频通话实时质量指标数据。
若要查询地域分布、设备平台、网络类型等维度的实时质量数据,建议调用 ListRealTimeQualityDistribution 接口。

使用说明

接口行为

可以调用 ListRealTimeQuality 接口,指定你所属的 AppId,指标类型和查询时间段,查询该时间段内指标的数据。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

注意事项

  • 最大请求次数:2 次/秒
  • 最远可查询时间:60 分钟
  • 最大单次查询时间跨度:60 分钟
  • 数据延迟:1 分钟

请求说明

  • 请求方式:POST
  • 请求地址:https://rtc.volcengineapi.com?Action=ListRealTimeQuality&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringListRealTimeQuality接口名称。当前 API 的名称为 ListRealTimeQuality
VersionString2020-12-01接口版本。当前 API 的版本为 2020-12-01

Body

参数类型是否必选示例值描述
AppIdStringYour_AppId你的音视频应用的唯一标志。
StartTimeString2021-07-24T00:00:00+08:00查询起始时间戳,格式为 RFC3339,单位为秒。
EndTimeString2021-07-24T00:10:00+08:00查询结束时间戳,格式为 RFC3339,单位为秒。
IndicatorArray of String["stall_rate","join_room_success_rate"]查询的指标名称。可同时查询多个指标。Indicator 可选值,参看质量数据相关 indicator
RoomIdStringYour_RoomId房间 ID,是房间的唯一标志。如果不填,代表查询该 AppId 的整体实时指标。
UserIdArray of String["user1","user2"]查询的用户 ID 列表,最多可以指定 20 个。值不合法时默认剔除。此字段仅在 RoomID 不为空时生效。

返回参数

下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构

参数类型示例值描述
RoomIdStringYour_RoomId房间 ID
UserIdArray of String["user1","user2"]用户 ID
IndicatorsArray of Indicators-具体指标数据

Indicators

参数类型示例值描述
NameString5s_join_room_success_rate指标名称
UnitString%指标的单位
DataArray of Data具体的指标值以及对应时间

Data

参数类型示例值描述
TimeStampString2021-07-24T00:00:00+08:00指标聚合时间,即指标值对应时间段的开始时刻(每 30s 一聚合)。格式为 RFC3339 规范。指标聚合时间,即指标值对应时间段的开始时刻(每 30s 一聚合)。格式为 RFC3339 规范。
ValueDouble99.99指标值,浮点数,保留两位小数。指标值,浮点数,保留两位小数。

请求示例

POST https://rtc.volcengineapi.com?Action=ListRealTimeQuality&Version=2020-12-01
{
    "AppId" : "Your_AppId",
    "StartTime" : "2021-07-24T00:00:00+08:00",
    "EndTime" : "2021-07-24T00:10:00+08:00",
    "Indicator":["stall_rate","join_room_success_rate"],
    "RoomId":"Your_RoomId",
    "UserId":["user1","user2"]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "ListRealTimeQuality",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "RoomId": "Your_RoomId",
        "UserId": [
            "user1",
            "user2"
        ],
        "Indicators": [
            {
                "Name": "5s_join_room_success_rate",
                "Unit": "%",
                "Data": [
                    {
                        "TimeStamp": "2021-07-24T00:00:00+08:00",
                        "Value": 98.68
                    },
                    {
                        "TimeStamp": "2021-07-24T00:00:30+08:00",
                        "Value": 98.20
                    },
                    {
                        "TimeStamp": "2021-07-24T00:01:00+08:00",
                        "Value": 98.30
                    }
                ]
            },
            {
                "Name": "10s_join_room_success_rate",
                "Unit": "%",
                "Data": [
                    {
                        "TimeStamp": "2021-07-24T00:00:00+08:00",
                        "Value": 99.68
                    },
                    {
                        "TimeStamp": "2021-07-24T00:00:30+08:00",
                        "Value": 99.20
                    },
                    {
                        "TimeStamp": "2021-07-24T00:01:00+08:00",
                        "Value": 99.40
                    }
                ]
            }
        ]
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。