ListTemplates - 列出符合条件的模板

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

接口说明

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

调试

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

授权信息

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

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

请求参数

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

当前页码。默认值为 1。

1
PageSizelong

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

20
Typestring

模板类型。

枚举值:
  • TimelineTimeline
  • VETemplateVETemplate
Timeline
Statusstring

模板状态。

枚举值:
  • UploadFailed上传失败
  • ProcessFailed高级模板分析失败
  • Available正常
  • Uploading上传中
  • Created已创建,还不能使用
  • Processing高级模板分析中
Available
CreateSourcestring

创建来源。

枚举值:
  • AliyunConsole通过阿里云控制台创建
  • WebSDK通过WebSDK创建
  • OpenAPI通过OpenAPI创建
OpenAPI
Keywordstring

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

****20b48fb04483915d4f2cd8ac****
SortTypestring

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

枚举值:
  • CreationTime:ASC按照创建时间正序
  • CreationTime:Desc按照创建时间倒序
CreationTime:Desc

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

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

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

100
Templatesarray<object>

模板列表。

Templatesobject

模板信息。

TemplateIdstring

模板 ID。

****20b48fb04483915d4f2cd8ac****
Namestring

模板名称。

云剪辑模板
Typestring

模板类型。

枚举值:
  • Timeline普通模板
  • VETemplate高级模板
Timeline
Configstring

模板配置。

参考Timeline模板配置详解
PreviewMediastring

预览素材。

****20b48fb04483915d4f2cd8ac****
Statusstring

模板状态。

枚举值:
  • UploadFailed上传失败
  • ProcessFailed高级模板分析失败
  • Available正常
  • Uploading上传中
  • Created已创建,还不能使用
  • Processing高级模板分析中
Available
CreateSourcestring

创建来源。

枚举值:
  • AliyunConsole通过阿里云控制台创建
  • WebSDK通过WebSDK创建
  • OpenAPI通过OpenAPI创建
OpenAPI
ModifiedSourcestring

修改来源。

枚举值:
  • AliyunConsole通过阿里云控制台创建
  • WebSDK通过WebSDK创建
  • OpenAPI通过OpenAPI创建
OpenAPI
PreviewMediaStatusstring

预览素材状态。

枚举值:
  • PrepareFail媒资分析失败
  • Init媒资初始化状态
  • Normal媒资正常
  • Preparing媒资分析中
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

剪辑参数。

{"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\"}"
    }
  ]
}

错误码

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