You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/API 参考/统计分析/DescribeLiveSourceStreamMetrics - 查询单路回源流监控数据
DescribeLiveSourceStreamMetrics - 查询单路回源流监控数据
最近更新时间：2025.04.22 19:10:54首次发布时间：2023.09.25 14:36:18
我的收藏
有用
有用
无用
无用

调用 DescribeLiveSourceStreamMetrics 接口，查询指定时间范围内单路回源流的音视频帧率、码率等监控数据，用于判断回源流的健康程度。

注意事项

  • 使用限制：支持查询已删除域名下回源流的历史监控数据。
  • 请求频率：单用户请求频率限制为 30 次/秒。
  • 数据延迟：数据延迟 30 秒。

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainString是pull.example.com拉流域名，您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看回源流使用的拉流域名。
AppString是live应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
StreamString是example_stream流名称，取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。

StartTime

String

是

2021-08-16T00:00:00+08:00

查询的开始时间，RFC3339 格式的时间戳，精度为秒。

说明

单次查询最大时间跨度为 1 天，历史查询最大时间范围为 366 天。

EndTimeString是2021-08-16T00:01:59+08:00查询的结束时间，RFC3339 格式的时间戳，精度为秒。
AggregationInteger否30数据聚合的时间粒度，单位为秒，当前接口默认且仅支持按 30 秒进行数据聚合。

返回参数

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

参数类型示例值描述
DomainStringpull.example.com拉流域名。
AppStringlive应用名称。
StreamStringexample_stream流名称。
StartTimeString2021-08-16T00:00:00+08:00查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTimeString2021-08-16T00:01:59+08:00查询的结束时间，RFC3339 格式的时间戳，精度为秒。
AggregationInteger30数据聚合的时间粒度，单位为秒。
MetricListArray of MetricList-所有时间粒度的数据。

MetricList

参数类型示例值描述
TimeStampString2022-04-13T00:00:00+08:00数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。
BitrateFloat20当前数据聚合时间粒度内的视频码率最大值，单位为 kbps。
FramerateFloat20当前数据聚合时间粒度内的视频帧率最大值，单位为 fps
AudioFramerateFloat20当前数据聚合时间粒度内的音频帧率最大值，单位为 fps。
AudioBitrateFloat20当前数据聚合时间粒度内的音频码率最大值，单位为 kbps。
AudioPtsDouble1651831909当前数据聚合时间粒度内，最后一个音频帧的显示时间戳 PTS（Presentation Time Stamp），单位为毫秒。
VideoPtsDouble1651831910当前数据聚合时间粒度内，最后一个视频帧的显示时间戳 PTS（Presentation Time Stamp），单位为毫秒。
PtsDeltaFloat1当前数据聚合时间粒度内，所有音视频帧显示时间戳差值的最大值，即所有 AudioPts 与 VideoPts 差值的最大值，单位为毫秒。
AudioFrameGapFloat20当前数据聚合时间粒度内，相邻音频帧显示时间戳差值的最大值，单位为毫秒。
VideoFrameGapFloat20当前数据聚合时间粒度内，相邻视频帧显示时间戳差值的最大值，单位为毫秒。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeLiveSourceStreamMetrics",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Domain": "pusll.example.com",
        "App": "live",
        "Stream": "example_stream",
        "StartTime": "2021-08-16T00:00:00+08:00",
        "EndTime": "2021-08-16T00:01:59+08:00",
        "Aggregation": 30,
        "MetricList": [
            {
                "Time": "2022-04-13T00:00:00+08:00",
                "Bitrate": 20,
                "Framerate": 20,
                "AudioFramerate": 20,
                "AudioBitrate": 20,
                "AudioPts": 1651831909,
                "VideoPts": 1651831910,
                "PtsDelta": 1,
                "AudioFrameGap": 20,
                "VideoFrameGap": 20
            },
            {
                "Time": "2022-04-13T00:00:30+08:00",
                "Bitrate": 20,
                "Framerate": 20,
                "AudioFramerate": 20,
                "AudioBitrate": 20,
                "AudioPts": 1651831909,
                "VideoPts": 1651831910,
                "PtsDelta": 1,
                "AudioFrameGap": 20,
                "VideoFrameGap": 20
            }
        ]
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。