You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询单路推流监控数据

最近更新时间：2023.10.12 17:39:57

首次发布时间：2021.11.22 11:42:32

我的收藏

支持查询一定时间范围内单路直播推流的音视频帧率、码率等信息，用于判断直播推流的健康程度。支持查询删除域名的直播推流数据。

说明

该接口属于历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询单路推流监控数据接口。

注意事项

  • 请求频率：单用户请求频率限制为 100 次/秒。
  • 数据延迟：数据延迟为 3min。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=DescribePushStreamMetrics&Version=2020-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DescribePushStreamMetrics接口名称。当前 API 的名称为 DescribePushStreamMetrics。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。

Body

参数类型是否必选示例值描述
DomainString是example.com推流域名
AppString是example.app应用名称
StreamString是example_stream流名称
StartTimeString是2021-08-16T00:00:00+08:00查询的起始时间。支持最近 31d 内的任意时间点，RFC3339 格式的 UTC 时间，精度为 s，例如：2022-04-01T00:00:00+08:00
EndTimeString是2021-08-16T00:00:00+08:00查询的结束时间。结束时间需晚于 StartTime，且与 StartTime 间隔不超过 24h，RFC3339 格式的 UTC 时间，精度为 s，例如：2022-04-02T00:00:00+08:00 。
AggregationInteger否5聚合的时间粒度，单位为 s。支持的取值为 5 和 30，默认值为 30

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数类型示例值描述
DomainStringexample.com推流域名
AppStringexample_app应用名称
StreamStringexample_stream流名称
StartTimeString2021-08-16T00:00:00+08:00查询的起始时间
EndTimeString2021-08-16T00:01:59+08:00查询的结束时间
AggregationInteger5聚合的时间粒度
MetricListArray of MetricList-按指定时间粒度聚合的监控数据

MetricList

参数类型示例值描述
TimeString2022-04-13T00:00:00+08:00时间戳。RFC3339 格式的 UTC 时间，例如，2022-04-13T00:00:00+08:00
BitrateFloat20视频码率，单位为 kbps
FramerateFloat20视频帧率，单位为 fps
AudioFramerateFloat20音频帧率，单位为 fps
AudioBitrateFloat20音频码率，单位为 kbps
AudioPtsInteger9558439音频显示时间戳 PTS（Presentation Time Stamp），单位为 ms
VideoPtsInteger9558430视频显示时间戳 PTS（Presentation Time Stamp），单位为 ms
PtsDeltaInteger9音视频时间戳差值，即 AudioPts 与 VideoPts 之间的差值，单位为 ms
AudioFrameGapInteger20音频帧间隔，单位为 ms
VideoFrameGapInteger20视频帧间隔，单位为 ms

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribePushStreamMetrics&Version=2020-08-01
{
  "Domain": "example.com",
  "App": "example_app",
  "Stream": "example_stream",
  "StartTime": "2021-08-16T00:00:00+08:00",
  "EndTime": "2021-08-16T00:01:59+08:00",
  "Aggregation": 5
}

返回示例

{
    "ResponseMetadata":{
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribePushStreamMetrics",
        "Version": "2020-08-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result":{
        "Domain": "example.com",
        "App": "example_app",
        "Stream": "example_stream",
        "StartTime": "2021-08-16T00:00:00+08:00",
        "EndTime": "2021-08-16T00:01:59+08:00",
        "Aggregation": 5,
        "MetricList": [
          {
              "Time": "2022-04-13T00:00:00+08:00",
              "Bitrate": 20,
              "Framerate": 20,
              "AudioFramerate": 20,
              "AudioBitrate": 20,
              "AudioPts": 9558439,
              "VideoPts": 9558430,
              "PtsDelta": 9,
              "AudioFrameGap": 20,
              "VideoFrameGap": 20,
          },
          {
              "Time": "2022-04-13T00:00:05+08:00",
              "Bitrate": 20,
              "Framerate": 20,
              "AudioFramerate": 20,
              "AudioBitrate": 20,
              "AudioPts": 9558400,
              "VideoPts": 9558401,
              "PtsDelta": 1,
              "AudioFrameGap": 20,
              "VideoFrameGap": 20,
          }
        ]
    }
}

错误码

访问公共错误码获取详细信息。