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

查询录制历史详情

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

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

我的收藏

调用接口查询指定 Vhost 下的直播录制历史信息。包括但不限于录制时长、文件格式、开始时间、结束时间。

说明

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostString否push.example.com域名空间名称。由 1 到 60 位数字、字母、下划线及"-"和"."组成
AppString否live应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成
StreamString否stream-123流名称，默认查询所有流名称，由 1 到 100 位数字、字母、下划线及"-"和"."组成，如果指定 Stream，必须同时指定 App 的值
DateFromString是2021-08-16T00:00:00+08:00开始推流时间，RFC3339 格式的 UTC 时间，精度为 s，例如：2022-04-01T00:00:00+08:00
DateToString是2021-08-17T00:00:00+08:00结束推流时间，结束时间需晚于 DateFrom，且与 DateFrom 间隔不超过 7天，RFC3339 格式的 UTC 时间，精度为 s，例如：2022-04-01T00:00:00+08:00
PageNumInteger是1分页查询页码
PageSizeInteger是30单个分页中，查询的结果数量

Type

String

否

tos

录制文件保存位置。默认取值为 tos。

  • tos
  • vod

返回参数

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

参数类型示例值描述
DataArray of Data-录制文件列表
PaginationObject of Pagination-分页信息

Data

参数类型示例值描述
VhostStringpush.example.com域名空间名称。由 1 到 60 位数字、字母、下划线及"-"和"."组成
AppStringlive应用名称
StreamStringstream-123流名称
BucketStringlive-record-testToS 存储空间
PathStringest6/record/push.example.org/live/testStream413ToS 中的保存路径
DurationString01:34录制时长
StartTimeString2021-08-16T00:00:00+08:00开始推流时间
FormatStringm3u8录制文件存储格式
EndTimeString2021-08-17T00:00:00+08:00结束推流时间
FileNameString1630331125_16303312***.m3u8录制文件的文件名
VidStringv03713g100**********bob16pnh65g录制文件保存在 VoD 时，录制视频的 ID

Pagination

参数类型示例值描述
PageCurInteger1当前页
PageSizeInteger10当前页的大小
PageTotalInteger1当前页的数据量
TotalCountInteger1数据总量

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeRecordTaskFileHistory&Version=2020-08-01
{
  "Vhost": "push.example.com",
  "App": "live",
  "Stream": "stream-123",
  "DateFrom": "2021-08-16T00:00:00+08:00",
  "DateTo": "2021-08-17T00:00:00+08:00",
  "PageNum": 1,
  "PageSize": 30
}

返回示例

{
  "ResponseMetadata": {
    "RequestID": "202108302155380102252431000500BC2E",
    "Action": "DescribeRecordTaskFileHistory",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "Data": [
      {
        "Vhost": "push.example.com",
        "App": "live",
        "Stream": "testStream413",
        "Bucket": "live-test6",
        "Path": "est6/record/push.example.com/live/testStream413",
        "Duration": "01:34",
        "StartTime": "2021-08-17T00:00:00+08:00",
        "Format": "",
        "EndTime": "2021-08-16T00:00:00+08:00",
        "FileName": "1630331125_16303312***.m3u8"
      }
    ],
    "Pagination": {
      "PageCur": 1,
      "PageSize": 10,
      "PageTotal": 1,
      "TotalCount": 1
    }
  }
}

错误码

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