功能介绍
默认接口请求频率限制:500次/秒。
创建录制模板,支持自动录制和按需录制两种模式。
接口约束
· 该模板之前没有创建过,且模板名称不能重复。
· 模板创建后,默认存储路径无法修改。
URI
GET /v1?
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateRecordTemplate | 操作接口名,系统规定参数。 |
TemplateName | String | 是 | 录制模板 | 模板名称,长度为4-64位,可包含大小写字母、数字、中文、中划线、下划线、小括号、空格,不能以空格作为名称的首尾。 |
Description | String | 否 | 录制模板 | 模板描述,长度不超过255个字符。 |
RecordType | Long | 否 | 1 | 是否启用自动录制,默认1。取值:1(自动录制), 2(按需录制) |
HlsParam | String | 否 | {"Enable":1} | Hls录制参数,开启Hls录制时设置。Hls,flv,mp4需要至少选择一种。该字段传对应json字符串。 |
FlvParam | String | 否 | {"Enable":1} | Flv录制参数,开启Flv录制时设置。Hls,flv,mp4需要至少选择一种。该字段传对应json字符串。 |
Mp4Param | String | 否 | {"Enable":1} | Mp4录制参数,开启Mp4录制时设置。Hls,flv,mp4需要至少选择一种。该字段传对应json字符串。 |
RecordParam
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Enable | Long | 是 | 0 | 是否开启当前格式录制,默认0。取值: 0(不开启), 1(开启) |
Interval | Long | 否 | 1800 | 录制间隔,单位秒,默认1800,30分钟。取值:300-7200Enable为1时,该字段为必填项。 |
StorageTime | Long | 否 | 604800 | 存储时长,单位秒。默认0,0表示永久存储,604800表示一周。 |
Path | String | 否 | {DeviceId}/ record/ {StartTime} | 存储路径。默认为{DeviceId}/ record/ {StartTime} 支持的特殊占位符有: {DeviceId}: 设备ID {StartTime}: 文件开始时间 |
返回参数
参数 | 类型 | 描述 |
---|---|---|
TemplateId | String | 模板ID。 |
CreatedTime | String | 模板创建时间。 |
UpdatedTime | String | 模板更新时间。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=CreateRecordTemplate&Description=%E5%BD%95%E5%88%B6%E6%A8%A1%E6%9D%BF&Mp4Param.Enable=1&Mp4Param.Interval=1800&Mp4Param.Path=%7BDeviceId%7D%2Frecord%2F%7BStartTime%7D&Mp4Param.StorageTime=20&RecordType=1&TemplateName=hmvbat
Connection: keep-alive
ctyun-eop-request-id: b2abb1d2-6ce8-401e-ba81-7ff2bcb44e6d
Eop-date: 20221025T094304Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=MT13uvjjfT6fTQuvIdN3IWhWqwgrBhmrGhb0d0I3nps=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.14)
返回示例
{
"RequestId": "a193158d84734d7a9121bda4d7c92a63",
"TemplateId": "581828645398233088",
"CreatedTime": "2022-10-25 09:43:04",
"UpdatedTime": "2022-10-25 09:43:04"
}