1. 接口描述

接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制：500次/秒。

创建录制模板，支持自动录制和按需录制两种模式。

2. 请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateRecordTemplate	操作接口名，系统规定参数。
TemplateName	String	是	录制模板	模板名称，长度为4-64位，可包含大小写字母、数字、中文、中划线、下划线、小括号、空格，不能以空格作为名称的首尾。
Description	String	否	录制模板	模板描述，长度不超过255个字符。
RecordType	Long	否	1	是否启用自动录制，默认1。取值：1(自动录制), 2(按需录制)
HlsParam	RecordParam	否	Hls,flv,mp4需要至少选择一种	Hls录制参数,开启Hls录制时设置。
FlvParam	RecordParam	否	Hls,flv,mp4需要至少选择一种	Flv录制参数,开启Flv录制时设置。
Mp4Param	RecordParam	否	Hls,flv,mp4需要至少选择一种	Mp4录制参数,开启Mp4录制时设置。

RecordParam

参数	类型	是否必选	示例值	描述
Enable	Long	是	0	是否开启当前格式录制，默认0。取值: 0(不开启), 1(开启)
Interval	Long	否	1800	录制间隔，单位秒，默认1800，30分钟。取值：300-7200 Enable为1时，该字段为必填项。
StorageTime	Long	否	604800	0表示永久存储，单位秒。默认为0，604800表示一周
Path	String	否	{DeviceId}/record/{StartTime}	存储路径。默认为{DeviceId}/record/{StartTime} 支持的特殊占位符有： {DeviceId}: 设备ID {StartTime}: 文件开始时间

3. 返回参数

参数	类型	描述
TemplateId	String	模板ID。
CreatedTime	String	模板创建时间。
UpdatedTime	String	模板更新时间。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

4.1 请求示例

https://vssapi.ctyun.cn/
?Action=CreateRecordTemplate
&TemplateName=record-template
&Description=description
&RecordType=1
&HlsParam.Enable=1
&HlsParam.Interval=1800
&HlsParam.Path={DeviceId}/record/{StartTime}
&HlsParam.StorageTime=0
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=R8Z1%2FTe1SKLV0ms362xJTyyDdpo%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=66867469
&SignatureVersion=1.0
&Timestamp=1599099503

4.2 返回示例

{
  "RequestId": "8135f15f8cf44cf883dde9e85b54830b",
  "TemplateId": "1469703465287680",
  "CreatedTime": "2020-09-03 10:18:31",
  "UpdatedTime": "2020-09-03 10:18:31"
}

5. 错误码

ErrorCode	ErrorMessage

创建录制模板

最近更新时间：2025-02-21 02:50:54

1. 接口描述

2. 请求参数

RecordParam

3. 返回参数

4. 示例

4.1 请求示例

4.2 返回示例

5. 错误码