修改模板信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vs:ModifyTemplate | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Id | string | 是 | 模板 ID。 | 323*****998-cn-qingdao |
Name | string | 否 | 模板名称。 | 录制模板 |
Description | string | 否 | 模板描述。 | 录制模板 |
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 |
Interval | long | 否 | 操作周期,单位秒。 | 3600 |
Retention | long | 否 | 时移保存周期,单位:天 | 3 |
FileFormat | string | 否 | 存储文件格式,多值用逗号分隔。取值:
说明
青岛单元暂不支持 flv、mp4 录制
| hls |
JpgOverwrite | string | 否 | JPG 的存储路径,用于覆盖截图。
| osspath/snapshot/{AppName}/{StreamName}.jpg |
JpgSequence | string | 否 | JPG 的存储路径,用于序列截图。
| osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg |
JpgOnDemand | string | 否 | JPG 的存储路径,用于按需截图。
| osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg |
Mp4 | string | 否 | MP4 的存储路径。
| 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 文件。
| 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}] |
返回参数
示例
正常返回示例
JSON
格式
{
"Id": "323*****998-cn-qingdao",
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664"
}
错误码
访问错误中心查看更多错误码。