ListTemplates - 列出符合条件的模板

列出符合条件的模板,支持根据模板状态、创建来源等信息查询。

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

模板类型

Timeline
Statusstring

模板状态,取值范围:

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

创建来源,取值范围:

  • AliyunConsole
  • OpenAPI
  • WebSDK
OpenAPI
Keywordstring

搜索关键词,可以根据模板ID和title搜索

****20b48fb04483915d4f2cd8ac****
SortTypestring

排序参数,默认根据创建时间倒序

CreationTime:Desc
PageNoLong

当前页码。默认值为1。

1
PageSizeLong

分页大小,每页显示条数。默认值为20,最大值为100。

20

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID

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

本次请求条件下的数据总量。

100
Templatesarray

模板列表

object

模板信息

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

预览素材状态

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

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

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "TotalCount": 100,
  "Templates": [
    {
      "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\"}"
    }
  ]
}

错误码

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

阿里云首页 智能媒体生产 相关技术圈