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

文档中心

立即注册

导航

云端回放列表

最近更新时间：2023.08.11 21:23:00首次发布时间：2021.11.25 17:21:46

查询指定设备在云端保存的视频回放列表。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListDeviceRecords
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
SpaceID	Query	String	是	空间 ID	可通过调用 ListSpaces 接口获取
StreamID	Query	String	否	视频流 ID	可通过调用 ListStreams 接口获取说明：与 “DeviceNSID+ ChannelID+ StreamingIndex+ Resolution” 组合二选一
DeviceNSID	Query	String	否	设备国标 ID	说明：“DeviceNSID+ ChannelID+ StreamingIndex+ Resolution” 组合中，DeviceNSID 和 ChannelID 必传，StreamingIndex 和Resolution 选传
ChannelID	Query	String	否	通道 ID
StreamingIndex	Query	Integer	否	主子码流编号： 0：主码流 1~n: 子码流
Resolution	Query	String	否	分辨率编码（可参考 GB28181-2022 协议附录G中的定义）
ReqType	Query	String	否	请求类型	支持 record_metadata，用于查询ts文件

Body 参数

字段	类型	必填	说明
StartTs	Timestamp	是	查询的起始时间，例如：2023-07-03T18:30:00+08:00
EndTs	Timestamp	是	查询的结束时间，例如：2023-07-03T18:40:00+08:00

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
Type	String	查询对象的类型： record：视频 screenshot：截图 record_metadata：元数据
Path	String	文件路径： record 和 screenshot 查询对象返回完整的 URL record_metadata 查询对象返回对象存储中的 key，结合 RecordMeta 中的 bucket 可以定位文件
Screenshot	Object	截图信息
Record	Object	视频信息，参考以下 Record 数据结构说明
RecordMeta	Object	元数据信息，参考以下 RecordMeta 数据结构说明

Record 数据结构说明

字段	类型	说明
StartTs	String	视频开始时间，例如：2021-12-06T17:49:32+08:00
EndTs	String	视频结束时间，例如：2021-12-06T17:59:32+08:00
Duration	Number	视频时长，单位：毫秒
Cover	String	视频封面地址
Format	String	文件格式：mp4/hls

RecordMeta 数据结构说明

字段	类型	说明
StartTs	String	视频开始时间，例如：2021-12-06T17:49:32+08:00
EndTs	String	视频结束时间，例如：2021-12-06T17:59:32+08:00
Duration	Number	视频时长，单位：毫秒
Format	String	视频格式：ts
Bucket	String	对象存储中的存储桶名称
StorageType	String	在对象存储中保存录像文件的类型： STANDARD（标准存储） IA（低频存储） ARCHIVE_FR（归档闪回存储） COLD_ARCHIVE（冷归档存储） NOT_FOUND（文件被删除） UNKNOWN（未知状态）

示例

请求示例

POST https://open.volcengineapi.com?Action=ListDeviceRecords
&Version=2021-01-01
&SpaceID=cd9fa8a7-12a2-405b-a5f1-faaddfxxxxxx
&StreamID=b7a20edd-8e60-4f46-b4a9-6ae079xxxxxx
&<公共请求参数>
{
    "StartTs": "2023-07-01T17:49:30+08:00",
    "EndTs": "2023-07-02T16:20:00+08:00"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211208184328010211197144090010CF",
        "Action": "ListDeviceRecords",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": [
        {
            "Type": "record",
            "Path": "https://xxx.xxx.com/api/top/aiotvideo/PlayStreamRes/2021-01-01/?PlayUrl=UmVzUGF0aD1VR0ZuWlU1MWJUMHhKbEJoWjJWVGFYcGxQVEl3Sms5bVpuTmxkRDB5TUNaRVlYUmxSbkp2YlQweU1ESXhMVEV5TFRBMlZERTNPalE1T2pNeWZEQTRPakF3SmtSaGRHVlViejB5TURJeExURXlMVEEyVkRFM09qVTVPak15ZkRBNE9qQXdKa1IxY21GMGFXOXVQVFl3TUE9PSZSZXFUeXBlPXJlY29yZCZSZXNPd25lcj1iN2EyMGVkZC04ZTYwLTRmNDYtYjRhOS02YWUwNzkxNzQyZmUmTTNVOD0x",
            "Record": {
                "StartTs": "2021-12-06T17:49:32+08:00",
                "EndTs": "2021-12-06T17:59:32+08:00",
                "Duration": 6000,
                "Cover": "https://xxx.xxx.com/push-rtmp-2100053143-gb-1026.push.bfcdnbf.com/2100053143-gb-1026/34020084991320545039_34020084991320545039/20211206095924318.jpeg",
                "Format": "mp4"
            },
        },
        {
            "Type": "record_metadata",
            "Path": "tos_key",
            "RecordMeta": {
                "StartTs": "2021-12-06T17:59:32+08:00",
                "EndTs": "2021-12-06T18:09:32+08:00",
                "Duration": 4000,
                "Format":"ts",
                "Bucket":"test-zh",
                "StorageType": "STANDARD"
            }
        },
        ...
        ...
    ]
}