ListTemplates多条件查询剪辑模板列表-智能媒体服务-阿里云-智能媒体服务(IMS)-阿里云帮助中心

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

接口说明

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

使用普通模板，请参考：普通模板快速入门
使用高级模板，请参考：高级模板创建及使用

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListTemplates

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageNo	integer	否	当前页码。默认值为 1。	1
PageSize	integer	否	分页大小，每页显示条数。默认值为 20，最大值为 100。	20
Type	string	否	模板类型。枚举值： Timeline : Timeline BatchEditing : BatchEditing VETemplate : VETemplate	Timeline
Status	string	否	模板状态。枚举值： UploadFailed : 上传失败 ProcessFailed : 高级模板分析失败 Available : 正常 Uploading : 上传中 Created : 已创建，还不能使用 Processing : 高级模板分析中	Available
CreateSource	string	否	创建来源。枚举值： AliyunConsole : 通过阿里云控制台创建 WebSDK : 通过 WebSDK 创建 OpenAPI : 通过 OpenAPI 创建	OpenAPI
Keyword	string	否	搜索关键词，可以根据模板 ID 和 title 搜索。	**20b48fb04483915d4f2cd8ac**
SortType	string	否	排序参数，默认根据创建时间倒序。枚举值： CreationTime:ASC : 按照创建时间正序 CreationTime:Desc : 按照创建时间倒序	CreationTime:Desc

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求 ID。	****11-DB8D-4A9A-875B-275798****
TotalCount	integer	本次请求条件下的数据总量。	100
Templates	array<object>	模板列表。
	object	模板信息。
TemplateId	string	模板 ID。	**20b48fb04483915d4f2cd8ac**
Name	string	模板名称。	Cloud editing template
Type	string	模板类型。枚举值： Timeline : 普通模板 VETemplate : 高级模板	Timeline
Config	string	模板配置。	See Timeline template configuration details.
PreviewMedia	string	预览素材。	**20b48fb04483915d4f2cd8ac**
Status	string	模板状态。枚举值： UploadFailed : 上传失败 ProcessFailed : 高级模板分析失败 Available : 正常 Uploading : 上传中 Created : 已创建，还不能使用 Processing : 高级模板分析中	Available
CreateSource	string	创建来源。枚举值： AliyunConsole : 通过阿里云控制台创建 WebSDK : 通过 WebSDK 创建 OpenAPI : 通过 OpenAPI 创建	OpenAPI
ModifiedSource	string	修改来源。枚举值： AliyunConsole : 通过阿里云控制台创建 WebSDK : 通过 WebSDK 创建 OpenAPI : 通过 OpenAPI 创建	OpenAPI
PreviewMediaStatus	string	预览素材状态。枚举值： PrepareFail : 媒资分析失败 Init : 媒资初始化状态 Normal : 媒资正常 Preparing : 媒资分析中	Normal
CreationTime	string	创建时间。	2020-12-26T04:11:10Z
ModifiedTime	string	修改时间。	2020-12-26T04:11:10Z
CoverURL	string	封面 URL。	http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
ClipsParam	string	剪辑参数。	{"Media1":"mediaId","Text1":"text"}

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "TotalCount": 100,
  "Templates": [
    {
      "TemplateId": "****20b48fb04483915d4f2cd8ac****",
      "Name": "Cloud editing template",
      "Type": "Timeline",
      "Config": "See Timeline template configuration details.",
      "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\"}"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。