創建存儲模板
更新時間 2024-09-11 16:11:24
最近更新時間: 2024-09-11 16:11:24
分享文章
接口功能介紹
本接口用于創建視頻存儲模板，支持配置錄制類型、存儲時長等。
接口約束
請求參數說明：
String類型的參數，傳""等同于不傳。
Integer類型的參數，傳0等同于不傳。
Boolean類型的參數，傳false等同于不傳。
URI
POST /v2/recordTemplates
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| TemplateName | 是 | String | 模板名稱，4-64位，可包含大小寫字母、數字、中文、中劃線、下劃線、小括號、空格。 | 存儲模板 | |
| FileFormat | 否 | String | 錄像文件格式，默認m3u8。取值：m3u8：符合hls協議的m3u8文件；ps：符合國標協議的ps文件。 | m3u8 | |
| FileDuration | 否 | Integer | 錄像單文件時長，單位秒。 | 1800 | |
| RecordModes | 是 | Array of Objects | 錄制方式列表，可以配置多種錄制類型。 | RecordMode | |
| Description | 否 | String | 模板描述，長度小于等于255個字符。 | 描述 |
表 RecordMode
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| RecordType | 是 | Integer | 錄制類型。取值：1：全天錄制；2：循環定時錄制；3：指定時間錄制；5：手動錄制。 | 1 | |
| StorageTime | 是 | Integer | 存儲時長，單位秒，最小不少于30天。例：2592000表示30天。 | 2592000 | |
| WeekTimeSections | 否 | Array of Objects | 定時錄制的時間段，當RecordType為2時，該字段必選。 | WeekTimeSection | |
| SpecTimeSections | 否 | Array of Objects | 指定時間錄制的時間段，當RecordType為3時，該字段必選。 | 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 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼，執行成功時，不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據，執行失敗時，不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| RecordTemplateId | String | 模板ID。 | 717074786139029504 | |
| CreatedTime | String | 模板創建時間。 | 2023-04-25 15:15:07 | |
| UpdatedTime | String | 模板更新時間。 | 2023-04-25 15:15:07 | |
| RequestId | String | 請求ID。 | a194d4c32d4d4e489f70ac9296f46c72 |
枚舉參數
無
請求示例
請求url
POST '/v2/recordTemplates'
請求頭header
無
請求體body
{"TemplateName":"openapi-test","RecordModes":[{"RecordType":1,"StorageTime":2592000}]}
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "a194d4c32d4d4e489f70ac9296f46c72","returnObj": {"RecordTemplateId": "717074786139029504","CreatedTime": "2023-04-25 15:15:07","UpdatedTime": "2023-04-25 15:15:07","RequestId": "a194d4c32d4d4e489f70ac9296f46c72"}}
狀態碼
請參考
錯誤碼
請參考
