最近更新时间:2023.09.25 21:09:55
首次发布时间:2021.11.22 11:42:32
支持查询一定时间范围内单路直播推流的音视频帧率、码率等信息,用于判断直播推流的健康程度。支持查询删除域名的直播推流数据。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询单路推流监控数据接口。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribePushStreamMetrics | 接口名称。当前 API 的名称为 DescribePushStreamMetrics 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Domain | String | 是 | example.com | 推流域名 |
App | String | 是 | example.app | 应用名称 |
Stream | String | 是 | example_stream | 流名称 |
StartTime | String | 是 | 2021-08-16T00:00:00+08:00 | 查询的起始时间。支持最近 31d 内的任意时间点,RFC3339 格式的 UTC 时间,精度为 s,例如:2022-04-01T00:00:00+08:00 |
EndTime | String | 是 | 2021-08-16T00:00:00+08:00 | 查询的结束时间。结束时间需晚于 StartTime ,且与 StartTime 间隔不超过 24h,RFC3339 格式的 UTC 时间,精度为 s,例如:2022-04-02T00:00:00+08:00 。 |
Aggregation | Integer | 否 | 5 | 聚合的时间粒度,单位为 s。支持的取值为 5 和 30,默认值为 30 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | example.com | 推流域名 |
App | String | example_app | 应用名称 |
Stream | String | example_stream | 流名称 |
StartTime | String | 2021-08-16T00:00:00+08:00 | 查询的起始时间 |
EndTime | String | 2021-08-16T00:01:59+08:00 | 查询的结束时间 |
Aggregation | Integer | 5 | 聚合的时间粒度 |
MetricList | Array of MetricList | - | 按指定时间粒度聚合的监控数据 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Time | String | 2022-04-13T00:00:00+08:00 | 时间戳。RFC3339 格式的 UTC 时间,例如,2022-04-13T00:00:00+08:00 |
Bitrate | Float | 20 | 视频码率,单位为 kbps |
Framerate | Float | 20 | 视频帧率,单位为 fps |
AudioFramerate | Float | 20 | 音频帧率,单位为 fps |
AudioBitrate | Float | 20 | 音频码率,单位为 kbps |
AudioPts | Integer | 9558439 | 音频显示时间戳 PTS(Presentation Time Stamp),单位为 ms |
VideoPts | Integer | 9558430 | 视频显示时间戳 PTS(Presentation Time Stamp),单位为 ms |
PtsDelta | Integer | 9 | 音视频时间戳差值,即 AudioPts 与 VideoPts 之间的差值,单位为 ms |
AudioFrameGap | Integer | 20 | 音频帧间隔,单位为 ms |
VideoFrameGap | Integer | 20 | 视频帧间隔,单位为 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, } ] } }
访问公共错误码获取详细信息。