接口功能介绍
本接口用于查询视频存储模板列表。
接口约束
请求参数说明：
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"}}
状态码
请参考 状态码
错误码
请参考 错误码
