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

文档中心

立即注册

导航

回放列表V3

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

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetRecordList`	接口名称。当前 API 的名称为 `GetRecordList`。
Version	String	是	`2023-10-01`	接口版本。当前 API 的版本为 `2023-10-01`。

Body

参数	类型	是否必选	示例值	描述
StreamID	String	是	`2a772f0b-753c-4496-b535-a8df0fxxxxxx`	视频流 ID，可通过调用 ListStreams 接口获取（IPC 设备类型可以为空）。
StartTime	Integer	是	`1686153600`	查询录像的开始时间，Unix 时间戳，单位为秒。
EndTime	Integer	是	`1686182400`	查询录像的结束时间，Unix 时间戳，单位为秒。
RecordType	String	是	`all`	录像类型，支持的取值及含义如下所示。 time：定时录像； alarm：报警录像； manual：手动录像； all：所有类型（默认值）。
Order	Boolean	否	`true`	排序方式，取值及含义如下所示。 true：正序； false：倒序（默认值）。
TimeoutInSec	String	是	`10`	请求超时时间，单位为秒，请求超过超时间时间未成功时返回错误。

返回参数

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

参数	类型	示例值	描述
Num	Integer	`22`	查询到的记录数量。
Items	Array of Items	`-`	查询到的录像回放信息列表。

Items

参数	类型	示例值	描述
ChannelID	String	`4020035991320xxxxxx`	通道 ID。
Name	String	`men`	录像名称。
StartTime	Integer	`1686153600`	查询录像的开始时间，Unix 时间戳，单位为秒。
EndTime	Integer	`1686182400`	查询录像的结束时间，Unix 时间戳，单位为秒。
Secrecy	String	`1`	保密属性，取值及含义如下。 0：不涉密； 1：涉密。
Type	String	`1`	录像类型，支持的取值及含义如下所示。 time：定时录像； alarm：报警录像； manual：手动录像； all：所有类型（默认值）。
FileSize	Integer	`80`	录像文件大小，单位为 MB。

请求示例

POST https://open.volcengineapi.com?Action=GetRecordList&Version=2023-10-01
{
  "StreamID": "2a772f0b-753c-4496-b535-a8df0fxxxxxx",
  "StartTime": 1686153600,
  "EndTime": 1686182400,
  "RecordType": "all",
  "Order": true
}

返回示例

{
  "Result": {
    "Items": [
      {
        "Secrecy": "1",
        "StartTime": 1686153600,
        "Name": "men",
        "EndTime": 1686182400,,
        "ChannelID": "condensed",
        "FileSize": "0",
        "Type": "1"
      }
    ],
    "Num": 961
  },
  "ResponseMetadata": {
    "Action": "GetRecordList",
    "RequestId": "202306041104200100100232280022D31",
    "Region": "cn-north-1",
    "Version": "2023-10-01",
    "Service": "aiotvideo"
  }
}

错误码

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