云端回放列表V2--慢直播-火山引擎

文档中心

立即注册

导航

云端回放列表V2

最近更新时间：2024.02.29 14:55:33首次发布时间：2024.02.29 14:55:33

查询一路流的云端回放列表。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListStreamRecords`	接口名称。当前 API 的名称为 `ListStreamRecords`。
Version	String	是	`2023-10-01`	接口版本。当前 API 的版本为 `2023-10-01`。
PageNumber	String	否	`1`	查询数据的页码，默认为 1，表示查询第一页的数据。
PageSize	String	否	`20`	每页显示的数据条数，默认为 20，最大值为 30000。

Body

参数	类型	是否必选	示例值	描述
StreamID	String	是	`e4b32f7a-85cb-4370-aa07-cad62ab4c8a4`	主码流 ID，可通过调用 ListStreams 接口获取。
StreamingIndex	Integer	否	`1`	主子码流编号。 0：主码流； 1～n：子码流。
Resolution	String	否	`2`	分辨率编码（可参考 GB28181-2022 协议附录G中的定义）。
StartTime	Integer	是	`1699436336`	查询录像的开始时间，Unix 时间戳，单位为秒。
EndTime	Integer	是	`1699436436`	查询录像的结束时间，Unix 时间戳，单位为秒。
ReqType	String	否	`record_metadata`	请求类型，缺省情况下为空表示请求类型为转封装后的格式，支持的取值即含义如下所示。 record_metadata：请求类型为 ts 分片。
WithSub	Boolean	否	`false`	是否合并主子码流录像，支持的取值及含义如下所示。 false：不合并（默认值）； true：合并。

返回参数

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

参数	类型	示例值	描述
Type	String	`record_metadata`	请求类型。
Path	String	`ve_3wmh/lzd7j67brb2eft9n.push.aiotvideo.volces.com/38d26a12-718e-46eb-b326-bcd450bba84d/ts/1700095456-20231108T164359-6000-1699432678.ts`	请求类型为 ts 分片时，TOS保存ts的路径。
RecordMeta	Object of RecordMeta	`-`	请求类型为 ts 分片（ReqType为record_metadata）时，返回的 TS片段的元信息。
Record	Object of Record	`-`	请求类型为转封装视频时，录制文件的元数据信息。

RecordMeta

参数	类型	示例值	描述
StartTime	Integer	`1699433039`	分片的开始时间，Unix 时间戳，单位为秒。
EndTime	Integer	`1699433045`	分片的结束时间，Unix 时间戳，单位为秒。
Duration	Integer	`6000`	录像 TS 分片的时长，单位时毫秒（ms）。
Format	String	`ts`	分片的格式。
Bucket	String	`zh-test`	分片在 TOS 存储中的 Bucket 名称。
StorageType	String	`STANDARD`	Bucket 存储类型，取值及含义请参见 TOS 产品说明。

Record

参数	类型	示例值	描述
StartTime	Integer	`1699433039`	录制的开始时间，Unix 时间戳，单位为秒。
EndTime	Integer	`1699433045`	录制的结束时间，Unix 时间戳，单位为秒。
Duration	Integer	`6000`	录制文件时长，单位为毫秒（ms）。
Format	String	`mp4/hls`	录制文件转封装格式。

请求示例

POST https://open.volcengineapi.com?Action=ListStreamRecords&Version=2023-10-01&PageNumber=1&PageSize=20

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2023110816503711EBB5FFDF8E42425316",
    "Action": "ListStreamRecords",
    "Version": "2023-10-01",
    "Service": "aiotvideo",
    "Region": "cn-north-1"
  },
  "Result": [
    {
      "Type": "record_metadata",
      "Path": "ve_3wmh/lzd7j67brb2eft9n.push.aiotvideo.volces.com/38d26a12-718e-46eb-b326-bcd450bba84d/ts/1700095456-20231108T164359-6000-1699432678.ts",
      "RecordMeta": {
        "StartTime": 1699433039,
        "EndTime": 1699433045,
        "Duration": 6000,
        "Format": "ts",
        "Bucket": "zh-test",
        "StorageType": "STANDARD"
      }
    }
  ]
}

错误码

您可访问公共错误码，获取更多错误码信息。