查询回放列表统一接口
功能介绍
查询回放列表统一接口:v2相比于v1归一了所有查询回放列表相关的接口,v2接口支持查询前端和云端录像,支持好望和国标设备。
URI
GET /v2/{user_id}/devices/{device_id}/channels/{channel_id}/media/records
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
user_id |
是 |
String |
用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK章节 |
|
device_id |
是 |
String |
设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 国标设备:由数字组成,长度固定为20个字符长度,由客户自行设置,其中第11-13位,必须是以下之一132(IPC)、111(DVR)、118(NVR),用来区分设备类型 |
|
channel_id |
是 |
String |
通道ID: 好望设备:取值范围[0,999] 国标设备:由数字组成,长度为20个字符,由客户自行在设备侧设置,可以在web界面获取 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
start_time |
是 |
String |
开始时间:格式如:yyyy-MM-dd HHmmss |
|
end_time |
是 |
String |
结束时间:格式如:yyyy-MM-dd HHmmss |
|
record_position |
是 |
String |
录像位置,枚举类型 枚举值: CLOUD 云端录像 DEVICE 前端录像 |
|
record_type |
否 |
String |
录像类型:枚举类型,仅针对查询云端录像,不填则默认值为 ALL_RECORD 枚举值: |
|
limit |
否 |
String |
单页数量:取值范围[1,1000],不填写时默认值为 10 |
|
offset |
否 |
String |
偏移量:offset为0时表示查询第一页的数据,取值范围[0,1000000],不填写时默认值为 0 |
|
alarm_rec_type |
否 |
String |
告警录像种类(非告警录像值为null) |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Access-Token |
是 |
String |
用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
录像文件总数量 |
|
device_id |
String |
设备ID:设备唯一标识,长度范围[1,32] |
|
channel_id |
String |
通道ID:长度范围[1,20] |
|
records |
Array of ListDeviceRecordFilesResp objects |
录像列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
record_id |
String |
录像ID:长度范围[1,32],仅云端回放列表返回 |
|
record_name |
String |
录像文件名称:长度范围[1,32] |
|
record_type |
String |
录像类型:枚举类型 枚举值: |
|
storage_state |
Integer |
该接口返回参数新增storage_state(存储状态)枚举类型 枚举值
|
|
record_size |
Integer |
录像文件大小:单位(字节),仅云端回放列表返回 |
|
start_time |
String |
录像开始时间:格式:yyyy-MM-dd HH:mm:ss |
|
end_time |
String |
录像结束时间:格式:yyyy-MM-dd HH:mm:ss |
|
alarm_rec_type |
Array of string |
告警录像类型:枚举类型,非告警录像值为空(null) |
请求示例
查询前端的录像列表
GET /v2/123456789*****/devices/219123456CYP***/channels/0/media/records?start_time=2023-03-20 09:30:00&end_time=2023-03-20 19:30:00&limit=2&record_type=NORMAL_RECORD&record_position=CLOUD
响应示例
状态码: 200
查询设备录像列表响应
{
"total": 6,
"device_id": "219123456CYP***",
"channel_id": "0",
"records": [
{
"record_id": "12346556",
"record_name": "_0_0_.rf",
"record_type": "NORMAL_RECORD",
"storage_state": 0,
"record_size": 340017,
"start_time": "2023-03-20 09:30:00",
"end_time": "2023-03-20 09:44:39",
"alarm_rec_type": []
},
{
"record_id": "12346557",
"record_name": "_0_1_.rf",
"record_type": "NORMAL_RECORD",
"storage_state": 0,
"record_size": 340017,
"start_time": "2023-03-20 09:46:41",
"end_time": "2023-03-20 10:56:50",
"alarm_rec_type": []
}
]
}
状态码
请参见状态码
错误码
请参见错误码