接口功能介绍
本接口用于创建视频存储模板，支持配置录制类型、存储时长等。
接口约束
请求参数说明：
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"}}
状态码
请参考 状态码
错误码
请参考 错误码
