Queries a list of templates that meet the specified conditions. You can query templates based on information such as the template status and creation source.
Operation description
A template is an encapsulation of the timeline of a media editing and production job. You can define a common timeline as a template. When you have the same requirements, you need to only specify key parameters and materials to produce videos.
- For more information about how to use a regular template, see Create and use a regular template.
- For more information about how to use an advanced template, see Create and use advanced templates.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ice:ListTemplates | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Type | string | No | The template type. Valid values:
| Timeline |
| Status | string | No | The template state. Valid values:
| Available |
| CreateSource | string | No | The source from which the template was created. Valid values:
| OpenAPI |
| Keyword | string | No | The search keyword. You can use the template ID or title as the keyword to search for templates. | ****20b48fb04483915d4f2cd8ac**** |
| SortType | string | No | The sorting parameter. By default, the query results are sorted by creation time in descending order. Valid values:
| CreationTime:Desc |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"TotalCount": 100,
"Templates": [
{
"TemplateId": "****20b48fb04483915d4f2cd8ac****",
"Name": "",
"Type": "Timeline",
"Config": "",
"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\"}"
}
]
}Error codes
For a list of error codes, visit the Service error codes.