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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetTemplate

系统规定参数。取值：GetTemplate。

TemplateId String 否 ****20b48fb04483915d4f2cd8ac****

模板Id

返回数据

名称 类型 示例值 描述
RequestId String ******11-DB8D-4A9A-875B-275798******

请求Id
Template Object

模板信息
TemplateId String ****20b48fb04483915d4f2cd8ac****

模板ID
Name String 视频添加水印模板

模板名称
Type String Timeline

模板类型，目前支持：

  • Timeline
  • VETemplate
Config String 参考Timeline模板配置详解

模板配置
PreviewMedia String ****20b48fb04483915d4f2cd8ac****

预览素材
Status String Available

模板状态，取值范围

  • Available
  • Created
  • Uploading
  • Processing
  • UploadFailed
  • ProcessFailed
CreateSource String OpenAPI

创建来源，取值范围：

  • AliyunConsole
  • OpenAPI
  • WebSDK
ModifiedSource String OpenAPI

修改来源，取值范围：

  • AliyunConsole
  • OpenAPI
  • WebSDK
PreviewMediaStatus String Normal

预览素材状态

  • Init（初始状态：源文件未就绪）
  • Preparing（源文件准备中：比如上传中或者剪辑合成中）
  • PrepareFail（源文件准备失败：比如获取源文件信息失败）
  • Normal（正常：源文件已就绪）
CreationTime String 2020-12-26T04:11:10Z

创建时间
ModifiedTime String 2020-12-26T04:11:10Z

修改时间
CoverURL String http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg

封面URL
ClipsParam String {"Media1":"mediaId","Text1":"text"}

提交合成任务的ClipsParam参数模板，可把mediaId和text换成真实的参数来提交合成任务。使用方式参考：
RelatedMediaids String {"video":["******c04f1d4a06996144cc1a******"],"audio":["******c04f1d4a06996144cc1a******"],"image":["******c04f1d4a06996144cc1a******"]}

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

示例

请求示例

http(s)://[Endpoint]/?Action=GetTemplate
&TemplateId=****20b48fb04483915d4f2cd8ac****
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<GetTemplateResponse>
    <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>
    <Template>
        <TemplateId>****20b48fb04483915d4f2cd8ac****</TemplateId>
        <Name>视频添加水印模板</Name>
        <Type>Timeline</Type>
        <Config>参考Timeline模板配置详解</Config>
        <PreviewMedia>****20b48fb04483915d4f2cd8ac****</PreviewMedia>
        <Status>Available</Status>
        <CreateSource>OpenAPI</CreateSource>
        <ModifiedSource>OpenAPI</ModifiedSource>
        <PreviewMediaStatus>Normal</PreviewMediaStatus>
        <CreationTime>2020-12-26T04:11:10Z</CreationTime>
        <ModifiedTime>2020-12-26T04:11:10Z</ModifiedTime>
        <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg</CoverURL>
    </Template>
</GetTemplateResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/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"
  }
}

错误码

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

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