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

调试

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

请求参数

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

系统规定参数。取值:ListTemplates

Type String Timeline

模板类型

Status String Available

模板状态,取值范围:

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

创建来源,取值范围:

  • AliyunConsole
  • OpenAPI
  • WebSDK
Keyword String ****20b48fb04483915d4f2cd8ac****

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

SortType String CreationTime:Desc

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

返回数据

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

请求ID

TotalCount Integer 100

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

Templates Array of Templates

模板列表

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

模板ID

Name String 视频添加水印模板

模板名称

Type String Timeline

模板类型

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

预览素材状态

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListTemplates
&Type=Timeline
&Status=Available
&CreateSource=OpenAPI
&Keyword=****20b48fb04483915d4f2cd8ac****
&SortType=CreationTime:Desc
&公共请求参数

正常返回示例

XML格式

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

<ListTemplatesResponse>
    <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>
    <TotalCount>100</TotalCount>
    <Templates>
        <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>
    </Templates>
</ListTemplatesResponse>

JSON格式

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

错误码

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

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