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

查询拉流转推时长用量

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

首次发布时间：2022.04.19 20:40:35

我的收藏

创建拉流转推任务成功后，调用该接口查询拉流转推任务详细，如任务时长等。

说明

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

注意事项

请求频率：单用户请求频率限制为 1 次/秒。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
StartTimeString是2021-04-13T00:00:00+08:00查询的起始时间，RFC3339 格式的 UTC 时间，精度为 s，
EndTimeString是2021-04-14T00:00:00+08:00查询的结束时间，RFC3339 格式的 UTC 时间，精度为 s，

Aggregation

Integer

是

60

聚合时间粒度。默认值为 60，单位为 s，支持的取值如下所示。

  • 60：支持单次查询时间跨度为 24 小时，数据保存时长为 7 天；
  • 3600：支持单次查询时间跨度为 93 天，数据保存时长为 93 天；
  • 2678400：支持单次查询时间跨度为 366 天，数据保存时长为 366 天。

返回参数

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

参数类型示例值描述
SummaryObject of Summary-拉流转推时长汇总信息
ListArray of Datapoint-各时间片详细数据

Summary

参数类型示例值描述
TotalDurationFloat6查询范围内拉流转推总时长，单位分钟，保留小数点后 2 位

Datapoint

参数类型示例值描述
TimeString2021-04-13T00:00:00+08:00时间片起始时刻。RFC3339 格式的 UTC 时间，精度为 s，例如，2022-04-13T00:00:00+08:00
ValueFloat99该时间片内的拉流转推总时长，单位分钟，保留小数点后 2 位

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribePullToPushData&Version=2020-08-01
{
  "StartTime": "2021-04-13T00:00:00+08:00",
  "EndTime": "2021-04-14T00:00:00+08:00",
  "Aggregation": 60
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100****",
    "Action": "DescribePullToPushData",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "Summary": {
      "TotalDuration": 6
    },
    "List": [
      {
        "Time": "2021-04-13T00:00:00+08:00",
        "Value": 99
      }
    ]
  }
}

错误码

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