查詢錄像列表
更新時間 2024-09-11 16:11:30
最近更新時間: 2024-09-11 16:11:30
分享文章
接口功能介紹
本接口用于查詢設備錄制于云端的錄像文件列表，PlayUrl可用于點播該文件。
接口約束
查詢GB設備側錄像時，確保設備和流在線。
請求參數說明：
String類型的參數，傳""等同于不傳。
Integer類型的參數，傳0等同于不傳。
Boolean類型的參數，傳false等同于不傳。
URI
GET /v2/devices/*/records
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| DeviceId | 是 | String | 設備ID。 | 719340484461969408 |
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| OutNetwork | 否 | String | 播放網絡類型，默認internet。取值：internet：互聯網；vpn：視頻專網。 | internet | |
| RecordSource | 否 | String | 錄像來源。取值：cloud：默認云端；local：設備側錄像(僅國標設備支持)。 | cloud | |
| RecordType | 是 | Integer | 根據錄制類型查詢，取值：-1：所有錄制類型；1：全天錄制(按需計費)；2：循環定時錄制(按需計費)；3：指定時間錄制(按需計費)；5：手動錄制(按需計費)；6：全天錄制(資源包計費)。 | 1 | |
| StartTime | 是 | String | 根據開始時間查詢，小于結束時間，格式：yyyy-mm-dd HH:MM:SS。 | 2023-05-06 00:00:00 | |
| EndTime | 是 | String | 根據結束時間查詢，大于開始時間，格式：yyyy-mm-dd HH:MM:SS。 | 2023-05-07 00:00:00 | |
| SortBy | 否 | String | 選擇按一個字段排序。取值：StartTime：開始時間。 | StartTime | |
| SortDirection | 否 | String | 排序方式，默認升序。取值：asc(升序)，desc(降序)。 | asc | |
| PageNum | 否 | Integer | 第幾個分頁，默認為1。該字段僅在查詢云端錄像時有效。 | 1 | |
| PageSize | 否 | Integer | 分頁大小，默認為20，取值范圍為1～1000。該字段僅在查詢云端錄像時有效。 | 50 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼，執行成功時，不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據，執行失敗時，不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| DeviceId | String | 設備ID。 | 719340484461969408 | |
| Records | Array of Objects | 錄制文件列表。 | Record | |
| PageNum | Integer | 第幾個分頁。 | 1 | |
| PageSize | Integer | 分頁大小。 | 10 | |
| TotalPage | Integer | 分頁總數。 | 1 | |
| TotalNum | Integer | 錄制文件總數。 | 10 | |
| RequestId | String | 請求ID。 | b537b9e84f8c4adfb46bfd95df26d14b |
表 Record
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| RecordId | String | 錄制文件Id，該錄制文件的唯一性標識。 | 725052043643404288 | |
| FileFormat | String | 錄制文件格式。取值：m3u8，hls，mp4，ps。 | hls | |
| FileDuration | Integer | 錄制文件時長，單位秒。 | 1812 | |
| FileSize | Integer | 錄制文件大小，單位字節。 | 39125432 | |
| CoverUrl | String | 封面Url。 | xxx | |
| StartTime | String | 錄制文件開始時間。 | 2023-05-06 08:42:49 | |
| EndTime | String | 錄制文件結束時間。 | 2023-05-06 09:13:01 | |
| Audio | Object | 音頻屬性信息。 | Audio | |
| Video | Object | 視頻屬性信息。 | Video | |
| PlayUrl | Object | 錄制文件點播Url。 | PlayUrl |
表 Audio
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| Codec | String | 編碼格式，取值：g711a，aac，opus，mp3。 | aac |
表 Video
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| Codec | String | 編碼格式，取值：h264，h265。 | h265 |
表 PlayUrl
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| HlsUrl | String | hls播放url。FileFormat值為hls時，該字段有效。 | xxx | |
| PsUrl | String | ps播放url。FileFormat值為ps時，該字段有效。 | xxx |
枚舉參數
無
請求示例
請求url
GET '/v2/devices/719340484461969408/records'
請求頭header
無
請求體body
無
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "b537b9e84f8c4adfb46bfd95df26d14b","returnObj": {"DeviceId": "719340484461969408","PageNum": 1,"PageSize": 5,"TotalPage": 5,"TotalNum": 25,"Records": [{"RecordId": "725052043643404288","FileFormat": "hls","Audio": {"Codec": "aac"},"Video": {"Codec": "h265"},"PlayUrl": {"HlsUrl": "xxx","PsUrl": ""},"StartTime": "2023-05-06 08:42:49","EndTime": "2023-05-06 09:13:01","FileDuration": "1812","CoverUrl": "xxx","FileSize": "39125432"},{"RecordId": "725059053030031360","FileFormat": "hls","Audio": {"Codec": ""},"Video": {"Codec": "h265"},"PlayUrl": {"HlsUrl": "xxx","PsUrl": ""},"StartTime": "2023-05-06 09:13:02","EndTime": "2023-05-06 09:26:38","FileDuration": "816","CoverUrl": "xxx","FileSize": "17653764"},{"RecordId": "725059499706630144","FileFormat": "hls","Audio": {"Codec": ""},"Video": {"Codec": "h265"},"PlayUrl": {"HlsUrl": "xxx","PsUrl": ""},"StartTime": "2023-05-06 09:27:05","EndTime": "2023-05-06 09:27:30","FileDuration": "25","CoverUrl": "xxx","FileSize": "529220"},{"RecordId": "725062145406484480","FileFormat": "hls","Audio": {"Codec": ""},"Video": {"Codec": "h265"},"PlayUrl": {"HlsUrl": "xxx","PsUrl": ""},"StartTime": "2023-05-06 09:31:32","EndTime": "2023-05-06 09:32:36","FileDuration": "64","CoverUrl": "xxx","FileSize": "1373528"},{"RecordId": "725064722386862080","FileFormat": "hls","Audio": {"Codec": ""},"Video": {"Codec": "h265"},"PlayUrl": {"HlsUrl": "xxx","PsUrl": ""},"StartTime": "2023-05-06 09:36:32","EndTime": "2023-05-06 09:37:36","FileDuration": "64","CoverUrl": "xxx","FileSize": "1366760"}],"RequestId": "b537b9e84f8c4adfb46bfd95df26d14b","RecordType": 0}}
狀態碼
請參考
錯誤碼
請參考
