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

文档中心

立即注册

导航

回放列表V2

最近更新时间：2023.07.06 15:25:38首次发布时间：2023.07.06 15:25:38

查询设备本地录像回放列表。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetRecordListV2
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01

Body 参数

字段	类型	必填	说明
DeviceNSID	String	是	设备国标 ID，可通过调用 ListDevices 接口获取
ChannelID	String	是	通道 ID，可通过调用 ListStreams 接口获取（IPC 设备类型可以为空）
StartTime	Integer	是	查询起始时间，秒级时间戳，例如：1686153600
EndTime	Integer	是	查询结束时间，秒级时间戳，例如：1686182400
RecordType	String	否	录像类型： time（定时录像） alarm（报警录像） manual（手动录像） all（所有，默认）
TimeoutInSec	Integer	否	查询超时时间，单位：秒
Order	Boolean	否	排序方式： true（正序） false（倒序）

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
Num	Integer	查询到的记录数量
Item	Array of objects	查询到的录像回放信息列表，参考以下回放信息结构说明

回放信息结构说明

字段	类型	说明
ChannelID	String	设备通道 ID
Name	String	录像名称
StartTime	String	回放片段的开始时间
EndTime	String	回放片段的结束时间
StartTimeStamp	Integer	回放片段的开始时间的unix时间戳
EndTimeStamp	Integer	回放片段的结束时间的unix时间戳
Secrecy	String	保密属性： 0（不涉密） 1（涉密）
Type	String	录像类型
FileSize	String	录像文件大小，单位：字节

示例

请求示例

POST https://open.volcengineapi.com?Action=GetRecordListV2
&Version=2021-01-01
&<公共请求参数>
{
    "DeviceNSID": "34020056991320xxxxxx",
    "ChannelID": "34020000001320000001",
    "StartTime": 1686153600,
    "EndTime": 1686182400,
    "RecordType": "all",
    "TimeoutInSec": 30, 
    "Order": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022020809562401020404907915037F68",
        "Action": "GetRecordListV2",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "Num": 1,
        "Item": [
            {
               "ChannelID": "34020000001320000001",
               "Name": "录像01",
               "StartTime": "2023-06-08T02:29:27",
               "EndTime": "2023-06-08T03:39:49",
               "StartTimeStamp": 1686162567,
               "EndTimeStamp": 1686166789,
               "Secrecy": "1",
               "RecordType": "time",
               "FileSize": "1000000"     
        ]
}