最近更新时间：2023.10.23 16:15:04
首次发布时间：2023.09.25 14:36:18
支持查询一定时间范围内指定推流域名下直播推流的音视频帧率、码率等信息，用于判断直播推流的健康程度。支持查询删除域名的直播推流数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeLiveBatchPushStreamMetrics | 接口名称。当前 API 的名称为 DescribeLiveBatchPushStreamMetrics。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Domain | String | 是 | example.com | 推流域名。 |
| App | String | 否 | example.com | 应用名称。 |
Stream | String | 否 |
| 流名称。 说明 如果传了 Stream，需要同时传入 App。 |
| StartTime | String | 是 | 2021-08-16T00:00:00+08:00 | 查询的起始时间。支持最近 31d 内的任意时间点，RFC3339 格式的 UTC 时间，精度为 s。 |
| EndTime | String | 是 | 2021-08-16T00:01:59+08:00 | 查询的结束时间。结束时间需晚于 StartTime，且与 StartTime 间隔不超过 24h，RFC3339 格式的 UTC 时间，精度为 s。 |
| Aggregation | Integer | 否 | 5 | 聚合的时间粒度，单位为 s。支持的取值为 5、30 和 60，默认值为 60。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| 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 | 聚合的时间粒度。 |
| StreamMetricList | Array of StreamMetricList | - | 按指定时间粒度聚合的监控数据。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Domain | String | example.com | 推流域名。 |
| App | String | example_app | 应用名称。 |
| Stream | String | example_stream | 推流名称。 |
| MetricList | Array of MetricList | - | 按指定时间粒度聚合的监控数据。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TimeStamp | String | 2022-04-13T00:00:00+08:00 | 时间戳。RFC3339 格式的 UTC 时间，精度为 s。 |
| 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 | 9558438 | 视频显示时间戳 PTS（Presentation Time Stamp），单位为 ms。 |
| PtsDelta | Integer | 1 | 音视频时间戳差值，即 AudioPts 与 VideoPts 之间的差值，单位为 ms。 |
| AudioFrameGap | Integer | 20 | 音频帧间隔，单位为 ms。 |
| VideoFrameGap | Integer | 20 | 视频帧间隔，单位为 ms。 |
POST https://live.volcengineapi.com?Action=DescribeLiveBatchPushStreamMetrics&Version=2023-01-01 { "Domain": "example.com", "StartTime": "2021-08-16T00:00:00+08:00", "EndTime": "2021-08-16T00:01:59+08:00", "Aggregation": 5 }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "DescribeLiveBatchPushStreamMetrics", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "Domain": "example.com", "StartTime": "2021-08-16T00:00:00+08:00", "EndTime": "2021-08-16T00:01:59+08:00", "Aggregation": 5, "StreamMetricList": [ { "Domain": "example.com", "App": "example_app", "Stream": "example_stream", "MetricList": [ { "Time": "2022-04-13T00:00:00+08:00", "Bitrate": 20, "Framerate": 20, "AudioFramerate": 20, "AudioBitrate": 20, "AudioPts": 9558439, "VideoPts": 9558438, "PtsDelta": 1, "AudioFrameGap": 20, "VideoFrameGap": 20 } ] } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | CommonErr | - | 未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 400 | InvalidParam | - | 输入的参数无效或不符合要求，请参照请求参数说明进行检查。 |
| 400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验，请检查参数类型是否正确。 |
| 403 | RequestForbidden | - | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 404 | ResourceNotFound | - | 未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误，请联系技术支持。 |
| 502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时，请联系技术支持。 |