DescribeLivePushStreamMetrics - 查询单路推流监控数据--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLivePushStreamMetrics - 查询单路推流监控数据

最近更新时间：2024.12.17 15:46:21首次发布时间：2023.09.25 14:36:18

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

注意事项

使用限制：支持查询已删除域名产生的历史推流数据。
请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：数据延迟为 30 秒。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeLivePushStreamMetrics`	接口名称。当前 API 的名称为 `DescribeLivePushStreamMetrics`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
Domain	String	是	`push.example.com`	推流域名，您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的推流域名。
App	String	是	`live`	应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
Stream	String	是	`example_stream`	流名称，取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
StartTime	String	是	`2021-08-16T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。说明单次查询最大时间跨度为 1 天，历史查询最大时间范围为 366 天。
EndTime	String	是	`2021-08-16T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	否	`5`	数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。 `5`：5 秒； `30`：（默认值）30 秒。

返回参数

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

参数	类型	示例值	描述
Domain	String	`example.com`	推流域名。
App	String	`example_app`	应用名称。
Stream	String	`example_stream`	流名称。
StartTime	String	`2021-08-16T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2021-08-16T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`5`	数据聚合的时间粒度，单位为秒。 `5`：5 秒； `30`：30 秒。
MetricList	Array of MetricList	`-`	所有时间粒度的数据。

MetricList

参数	类型	示例值	描述
TimeStamp	String	`2022-04-13T00:00:00+08:00`	数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。
Bitrate	Float	`20`	当前数据聚合时间粒度内的视频码率最大值，单位为 kbps。
Framerate	Float	`20`	当前数据聚合时间粒度内的视频帧率最大值，单位为 fps。
AudioFramerate	Float	`20`	当前数据聚合时间粒度内的音频帧率最大值，单位为 fps。
AudioBitrate	Float	`20`	当前数据聚合时间粒度内的音频码率最大值，单位为 kbps。
AudioPts	Double	`9558439`	当前数据聚合时间粒度内，最后一个音频帧的显示时间戳 PTS（Presentation Time Stamp），单位为毫秒。
VideoPts	Double	`9558430`	当前数据聚合时间粒度内，最后一个视频帧的显示时间戳 PTS（Presentation Time Stamp），单位为毫秒。
PtsDelta	Float	`9`	当前数据聚合时间粒度内，所有音视频帧显示时间戳差值的最大值，即所有 AudioPts 与 VideoPts 差值的最大值，单位为毫秒。
AudioFrameGap	Float	`20`	当前数据聚合时间粒度内，相邻音频帧显示时间戳差值的最大值，单位为毫秒。
VideoFrameGap	Float	`20`	当前数据聚合时间粒度内，相邻视频帧显示时间戳差值的最大值，单位为毫秒。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLivePushStreamMetrics&Version=2023-01-01
{
  "Domain": "push.example.com",
  "App": "live",
  "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": "DescribeLivePushStreamMetrics",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "Domain": "push.example.com",
    "App": "live",
    "Stream": "example_stream",
    "StartTime": "2021-08-16T00:00:00+08:00",
    "EndTime": "2021-08-16T00:01:59+08:00",
    "Aggregation": 5,
    "MetricList": [
      {
        "TimeStamp": "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
      },
      {
        "TimeStamp": "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
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
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.	内部服务超时，请联系技术支持。

服务端 SDK

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