ListTemplates API Overview for IMS Media Templates - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:ListTemplates

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Type	string	No	The template type. Valid values: Timeline VETemplate Valid values: Timeline : Timeline VETemplate : VETemplate	Timeline
Status	string	No	The template state. Valid values: UploadFailed: Failed to upload the video. ProcessFailed: Failed to process the advanced template. Available: The template is available. Uploading: The video is being uploaded. Created: The template is created but not ready for use. Processing: The advanced template is being processed. Valid values: UploadFailed : ProcessFailed : Available : Uploading : Created : Processing :	Available
CreateSource	string	No	The source from which the template was created. Valid values: AliyunConsole WebSDK OpenAPI Valid values: AliyunConsole : WebSDK : OpenAPI :	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:Asc: sorted by creation time in ascending order. CreationTime:Desc: sorted by creation time in descending order. Valid values: CreationTime:ASC : CreationTime:Desc :	CreationTime:Desc

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
TotalCount	integer	The total number of entries returned.	100
Templates	array<object>	The queried templates.
	object	The template information.
TemplateId	string	The template ID.	**20b48fb04483915d4f2cd8ac**
Name	string	The template name.	Cloud Editing Template
Type	string	The template type. Valid values: Timeline: regular template. VETemplate: advanced template. Valid values: Timeline : VETemplate :	Timeline
Config	string	The template configurations.	Refer toTimelinetemplateConfiguration details
PreviewMedia	string	The preview media asset.	**20b48fb04483915d4f2cd8ac**
Status	string	The template state. Valid values: UploadFailed: Failed to upload the video. ProcessFailed: Failed to process the advanced template. Available: The template is available. Uploading: The video is being uploaded. Created: The template is created but not ready for use. Processing: The advanced template is being processed. Valid values: UploadFailed : ProcessFailed : Available : Uploading : Created : Processing :	Available
CreateSource	string	The source from which the template was created. Valid values: AliyunConsole WebSDK OpenAPI Valid values: AliyunConsole : WebSDK : OpenAPI :	OpenAPI
ModifiedSource	string	The source from which the template was modified. Valid values: AliyunConsole WebSDK OpenAPI Valid values: AliyunConsole : WebSDK : OpenAPI :	OpenAPI
PreviewMediaStatus	string	The state of the preview media asset. Valid values: PrepareFail Init Normal Preparing Valid values: PrepareFail : Init : Normal : Preparing :	Normal
CreationTime	string	The time when the template was created.	2020-12-26T04:11:10Z
ModifiedTime	string	The time when the template was last modified.	2020-12-26T04:11:10Z
CoverURL	string	The thumbnail URL.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
ClipsParam	string	The clip parameters.	{"Media1":"mediaId","Text1":"text"}

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "TotalCount": 100,
  "Templates": [
    {
      "TemplateId": "****20b48fb04483915d4f2cd8ac****",
      "Name": "Cloud Editing Template",
      "Type": "Timeline",
      "Config": "Refer toTimelinetemplateConfiguration 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\"}"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.