查詢存儲模板列表
更新時間 2024-09-11 16:11:25
最近更新時間: 2024-09-11 16:11:25
分享文章
接口功能介紹
本接口用于查詢視頻存儲模板列表。
接口約束
請求參數說明：
String類型的參數，傳""等同于不傳。
Integer類型的參數，傳0等同于不傳。
Boolean類型的參數，傳false等同于不傳。
URI
GET /v2/recordTemplates
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| SortBy | 否 | String | 選擇按一個字段排序，默認為CreatedTime，按照創建時間排序。取值：CreatedTime：創建時間；UpdatedTime：更新時間； | CreatedTime | |
| SortDirection | 否 | String | 排序方式，默認升序。取值：asc：升序；desc：降序。 | asc | |
| PageNum | 否 | Integer | 第幾個分頁，默認為1。 | 1 | |
| PageSize | 否 | Integer | 分頁大小，默認為20，取值范圍為1～1000。 | 20 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼，執行成功時，不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據，執行失敗時，不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| PageNum | Integer | 第幾個分頁。 | 1 | |
| PageSize | Integer | 分頁大小。 | 10 | |
| TotalPage | Integer | 分頁總數。 | 1 | |
| TotalNum | Integer | 模板總數。 | 10 | |
| RecordTemplates | Array of Objects | 模板列表。 | RecordTemplate | |
| RequestId | String | 請求ID。 | 813c0342f3754080ac18ee5f853ea1f0 |
表 RecordTemplate
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| RecordTemplateId | String | 模板Id。 | 717074786139029504 | |
| TemplateName | String | 模板名稱。 | test | |
| TemplateType | Integer | 模板類型，用于區分用戶創建模板，還是系統創建模板。取值：0：用戶創建模板；1：系統創建模板。 | 0 | |
| FileFormat | String | 錄像文件格式，默認m3u8。取值：m3u8：符合hls協議的m3u8文件；ps：符合國標協議的ps文件。 | m3u8 | |
| FileDuration | Integer | 錄像單文件時長，單位秒，默認3600。 | 1800 | |
| RecordModes | Array of Objects | 錄制方式列表，可以配置多種錄制類型。 | RecordMode | |
| Description | String | 模板描述。 | test | |
| CreatedTime | String | 模板創建時間。 | 2023-04-25 13:42:31 | |
| UpdateTime | String | 模板更新時間。 | 2023-04-25 13:42:31 |
表 RecordMode
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| RecordType | Integer | 錄制類型。取值：1：全天錄制；2：循環定時錄制；3：指定時間錄制；5：手動錄制。 | 1 | |
| StorageTime | Integer | 存儲時長，單位秒。例：2592000表示30天。 | 2592000 | |
| WeekTimeSections | Array of Objects | 循環定時錄制的時間段。 | WeekTimeSection | |
| SpecTimeSections | Array of Objects | 指定時間錄制的時間段。 | SpecTimeSection |
表 WeekTimeSection
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| DayofWeek | Integer | 日期。取值：1 |
1 | |
| StartTime | String | 錄制開始時間，格式：HH:mm:ss，范圍：[00:00:00~23:59:59]。 | 00:02:00 | |
| EndTime | String | 錄制結束時間，格式：HH:mm:ss，范圍：[00:00:00~23:59:59]。 | 00:05:00 |
表 SpecTimeSection
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| StartTime | String | 錄制開始時間，格式：YYYY-DD-MM HH:mm:ss。 | 2021-11-25 00:02:00 | |
| EndTime | String | 錄制結束時間，格式：YYYY-DD-MM HH:mm:ss。 | 2021-11-26 00:05:00 |
枚舉參數
無
請求示例
請求url
GET '/v2/recordTemplates?PageNum=1&PageSize=10'
請求頭header
無
請求體body
無
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "813c0342f3754080ac18ee5f853ea1f0","returnObj": {"PageNum": 1,"PageSize": 10,"RecordTemplates": [{"TemplateName": "默認30天存儲錄像模板","Description": "默認30天存儲錄像模板","RecordModes": [{"RecordType": 1,"WeekTimeSections": [],"SpecTimeSections": [],"StorageTime": "2592000"}],"FileFormat": "m3u8","FileDuration": "1800","RecordTemplateId": "692447984830267392","CreatedTime": "2023-03-23 10:52:50","TemplateType": 1}],"TotalPage": 1,"TotalNum": 1,"RequestId": "813c0342f3754080ac18ee5f853ea1f0"}}
狀態碼
請參考
錯誤碼
請參考
