ModifyTemplate - 修改模板

修改模板信息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Idstring

模板 ID。

323*****998-cn-qingdao
Namestring

模板名称。

录制模板
Descriptionstring

模板描述。

录制模板
Regionstring

OSS 所属区域,即服务中心。

cn-qingdao
OssBucketstring

OSS 的 Bucket。

bucketname
OssEndpointstring

OSS 的域名。

oss-cn-qingdao.aliyuncs.com
OssFilePrefixstring

OSS 文件前缀

oss-prefix
Triggerstring

模板触发类型,默认 auto。取值:

  • auto(自动)
  • ondemand(按需)
auto
Intervallong

操作周期,单位秒。

3600
Retentionlong

时移保存周期,单位:天

3
FileFormatstring

存储文件格式,多值用逗号分隔。取值:

  • mp4
  • flv
  • hls
说明 青岛单元暂不支持 flv、mp4 录制
hls
JpgOverwritestring

JPG 的存储路径,用于覆盖截图。

  • 目前仅支持生成 jpg 图片。
  • 支持变量匹配,包含{AppName}、{StreamName}
osspath/snapshot/{AppName}/{StreamName}.jpg
JpgSequencestring

JPG 的存储路径,用于序列截图。

  • 目前仅支持生成 jpg 图片。
  • 支持变量匹配,包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}
  • {UnixTimestamp}、{Sequence}必填一个
osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg
JpgOnDemandstring

JPG 的存储路径,用于按需截图。

  • 目前仅支持生成 jpg 图片。
  • 支持变量匹配,包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}
  • {UnixTimestamp}、{Sequence}必填一个
osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg
Mp4string

MP4 的存储路径。

  • 路径中支持变量匹配,可选{AppName}、{StreamName}、{Sequence}、{EscapedStartTime}、{EscapedEndTime}
  • 必须包含{EscapedStartTime}和{EscapedEndTime}
osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
Flvstring

FLV 的存储路径。格式参考 Mp4 说明。

osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
HlsM3u8string

HLS 的存储路径,m3u8 文件。格式参考 Mp4 说明。

osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
HlsTsstring

HLS 的存储路径,ts 文件。

  • 路径中支持变量匹配,可选{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}
  • 必须包含{UnixTimestamp}和{Sequence}变量
osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}
Callbackstring

模板执行后的回调。

http://example.com/callback
TransConfigsJSONstring

转码配置 TransConfig 类型的数组,JSON 格式字符串

[{"Fps":25,"Gop":50,"Height":720,"VideoCodec":"h264","Width":1280,"Name":"sd","VideoBitrate":800}]

返回参数

名称类型描述示例值
object
Idstring

模板 ID。

323*****998-cn-qingdao
RequestIdstring

请求 ID。

BEA5625F-8FCF-48F4-851B-CA63946DA664

示例

正常返回示例

JSON格式

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

错误码

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