列出符合条件的模板,支持根据模板状态、创建来源等信息查询。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:ListTemplates | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNo | long | 否 | 当前页码。默认值为 1。 | 1 |
PageSize | long | 否 | 分页大小,每页显示条数。默认值为 20,最大值为 100。 | 20 |
Type | string | 否 | 模板类型。 枚举值:
| Timeline |
Status | string | 否 | 模板状态。 枚举值:
| Available |
CreateSource | string | 否 | 创建来源。 枚举值:
| OpenAPI |
Keyword | string | 否 | 搜索关键词,可以根据模板 ID 和 title 搜索。 | ****20b48fb04483915d4f2cd8ac**** |
SortType | string | 否 | 排序参数,默认根据创建时间倒序。 枚举值:
| CreationTime:Desc |
返回参数
示例
正常返回示例
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\"}"
}
]
}
错误码
访问错误中心查看更多错误码。