调用CreateTemplate创建模板_视图计算(VECS)-阿里云帮助中心

创建新模板。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vs:CreateTemplate	create	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	模板名称。	录制模板
Description	string	否	模板描述。	录制模板
Type	string	是	模板类型。取值： record（录制） snapshot（截图） transcode（转码） timeshift（时移）	record
Region	string	否	OSS 所属区域，即服务中心。	cn-qingdao
OssBucket	string	否	OSS 的 Bucket。	bucketname
OssEndpoint	string	否	OSS 的域名。	oss-cn-qingdao.aliyuncs.com
OssFilePrefix	string	否	OSS 文件前缀	oss-prefix
Trigger	string	否	模板触发类型，默认 auto。取值： auto（自动） ondemand（按需）	auto
Interval	long	否	操作周期，单位秒。	3600
Retention	long	否	时移保存周期，单位：天	3
FileFormat	string	否	存储文件格式，多值用逗号分隔。取值： mp4 flv hls 说明青岛单元暂不支持 flv、mp4 录制	hls
JpgOverwrite	string	否	JPG 的存储路径，用于覆盖截图。目前仅支持生成 jpg 图片。支持变量匹配，包含{AppName}、{StreamName}	osspath/snapshot/{AppName}/{StreamName}.jpg
JpgSequence	string	否	JPG 的存储路径，用于序列截图。目前仅支持生成 jpg 图片。支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence} {UnixTimestamp}、{Sequence}必填一个	osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg
JpgOnDemand	string	否	JPG 的存储路径，用于按需截图。目前仅支持生成 jpg 图片。支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence} {UnixTimestamp}、{Sequence}必填一个	osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg
Mp4	string	否	MP4 的存储路径。路径中支持变量匹配，可选{AppName}、{StreamName}、{Sequence}、{EscapedStartTime}、{EscapedEndTime} 必须包含{EscapedStartTime}和{EscapedEndTime}	osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
Flv	string	否	FLV 的存储路径。格式参考 Mp4 说明。	osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
HlsM3u8	string	否	HLS 的存储路径，m3u8 文件。格式参考 Mp4 说明。	osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
HlsTs	string	否	HLS 的存储路径，ts 文件。路径中支持变量匹配，可选{AppName}、{StreamName}、{UnixTimestamp}、{Sequence} 必须包含{UnixTimestamp}和{Sequence}变量	osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}
Callback	string	否	模板执行后的回调。说明注：按需触发的模板不支持回调参数。	http://example.com/callback
TransConfigsJSON	string	否	转码配置 TransConfig 类型的数组，JSON 格式字符串	[{"Fps":25,"Gop":50,"Height":720,"VideoCodec":"h264","Width":1280,"Name":"sd","VideoBitrate":800}]

TransConfig 类型

参数	类型	必要	示例值	描述
Name	String	是	sd	转码规则名称。转码规则名称将作为转码流后缀，建议按使用习惯设置为 sd，200k 等易辨识后缀，只支持数字和字母。
VideoCodec	String	是	h264	视频编码取值：h264
VideoBitrate	Long	是	800	视频比特率，单位：kbps
Fps	Long	是	25	视频帧率，单位：fps
Gop	Long	是	50	视频 Gop，单位：帧
Height	Long	是	640	视频高度
Width	Long	是	1280	视频宽度

返回参数

名称	类型	描述	示例值
	object
Id	string	模板 ID。	399*****735-cn-qingdao
RequestId	string	请求 ID。	BEA5625F-8FCF-48F4-851B-CA63946DA664

示例

正常返回示例

JSON格式

{
  "Id": "399*****735-cn-qingdao",
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664"
}

错误码

访问错误中心查看更多错误码。