You need to enable JavaScript to run this app.
导航
ListStreamRecords - 查询流录像
最近更新时间:2025.06.06 17:05:58首次发布时间:2024.02.29 14:55:33
我的收藏
有用
有用
无用
无用

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

注意事项

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

请求说明

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

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

ListStreamRecords

要执行的操作,取值:ListStreamRecords。

Version
String

2023-10-01

API的版本,取值:2023-10-01。

StreamID
String

e4b32f7a-85cb-4370-aa07-cad62ab4c8a4

主码流 ID,可通过调用 ListStreams 接口获取。

PageNumber
String

1

查询数据的页码,默认为 1,表示查询第一页的数据。

StreamingIndex
Integer

1

主子码流编号。

  • 0:主码流;
  • 1~n:子码流。
PageSize
String

20

每页显示的数据条数,默认为 20,最大值为 30000。

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

请求类型为 ts 分片(ReqType为record_metadata)时,返回的
TS片段的元信息。

Record
Object

请求类型为转封装视频时,录制文件的元数据信息。

请求示例

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"
      }
    }
  ]
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
500
NotFoundStream

InvalidParameter.StreamNotFound