文档

GetTemplate - 获取模板信息

更新时间:

根据模板ID获取模板信息。高级模板有解析过长,当类型为高级模板时,Status为Available时即可使用。

接口说明

模板工厂是对剪辑合成时间线的一个封装,用户可以把常用的时间线定义成模板,当有同样的需求出现时,只需要传入关键参数及素材即可生产视频。

调试

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

授权信息

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

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

请求参数

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

模板 Id

****20b48fb04483915d4f2cd8ac****
RelatedMediaidFlagstring

相关媒体 ID 标记,默认值 0,当值为 1 时返回模板关联素材,仅普通模板有效。

0

返回参数

名称类型描述示例值
object

返回数据

RequestIdstring

请求 Id

******11-DB8D-4A9A-875B-275798******
Templateobject

模板信息

TemplateIdstring

模板 ID

****20b48fb04483915d4f2cd8ac****
Namestring

模板名称

视频添加水印模板
Typestring

模板类型,目前支持:

  • Timeline
  • VETemplate
Timeline
Configstring

模板配置

参考Timeline模板配置详解
PreviewMediastring

预览素材

****20b48fb04483915d4f2cd8ac****
Statusstring

模板状态,取值范围

  • Available
  • Created
  • Uploading
  • Processing
  • UploadFailed
  • ProcessFailed
Available
CreateSourcestring

创建来源,取值范围:

  • AliyunConsole
  • OpenAPI
  • WebSDK
OpenAPI
ModifiedSourcestring

修改来源,取值范围:

  • AliyunConsole
  • OpenAPI
  • WebSDK
OpenAPI
PreviewMediaStatusstring

预览素材状态

  • Init(初始状态:源文件未就绪)
  • Preparing(源文件准备中:比如上传中或者剪辑合成中)
  • PrepareFail(源文件准备失败:比如获取源文件信息失败)
  • Normal(正常:源文件已就绪)
Normal
CreationTimestring

创建时间

2020-12-26T04:11:10Z
ModifiedTimestring

修改时间

2020-12-26T04:11:10Z
CoverURLstring

封面 URL

http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
ClipsParamstring

提交合成任务的 ClipsParam 参数模板,可把 mediaId 和 text 换成真实的参数来提交合成任务。使用方式参考:

{"Media1":"mediaId","Text1":"text"}
RelatedMediaidsstring

模板关联素材,普通模板编辑器使用

{"video":["******c04f1d4a06996144cc1a******"],"audio":["******c04f1d4a06996144cc1a******"],"image":["******c04f1d4a06996144cc1a******"]}

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Template": {
    "TemplateId": "****20b48fb04483915d4f2cd8ac****",
    "Name": "视频添加水印模板",
    "Type": "Timeline",
    "Config": "参考Timeline模板配置详解",
    "PreviewMedia": "****20b48fb04483915d4f2cd8ac****",
    "Status": "Available",
    "CreateSource": "OpenAPI",
    "ModifiedSource": "OpenAPI",
    "PreviewMediaStatus": "Normal",
    "CreationTime": "2020-12-26T04:11:10Z",
    "ModifiedTime": "2020-12-26T04:11:10Z",
    "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg",
    "ClipsParam": "{\"Media1\":\"mediaId\",\"Text1\":\"text\"}",
    "RelatedMediaids": "{\"video\":[\"******c04f1d4a06996144cc1a******\"],\"audio\":[\"******c04f1d4a06996144cc1a******\"],\"image\":[\"******c04f1d4a06996144cc1a******\"]}"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史