ListTemplates-Intelligent Media Services(IMS)-阿里云帮助中心

Lists templates that meet specified conditions. You can query templates by status, creation source, and other information.

Operation description

Template Factory encapsulates editing and synthesis timelines. You can define commonly used timelines as templates. When similar requirements arise, you only need to pass key parameters and media assets to produce videos.

To use standard templates, refer to Quick start for standard templates.
To use advanced templates, refer to 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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Type	string	No	The page number. Default value: 1. Valid values: Timeline : Timeline BatchEditing : BatchEditing VETemplate : VETemplate	1
Status	string	No	The number of entries per page. Default value: 20. Maximum value: 100. Valid values: ProcessFailed : Advanced template analysis failed. UploadFailed : Upload failed. Available : Normal. Uploading : Uploading. Created : Created but not yet available. Processing : Advanced template analysis in progress.	20
CreateSource	string	No	The templatetype. Valid values: AliyunConsole : Created in the Alibaba Cloud console. WebSDK : Created by using WebSDK. OpenAPI : Created by using OpenAPI.	Timeline
Keyword	string	No	The template status.	Available
SortType	string	No	The creation source. Valid values: CreationTime:ASC : Ascending order of creation time. CreationTime:Desc : Descending order of creation time.	OpenAPI

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 that meet the request conditions.	100
Templates	array<object>	The list of templates.
	object	The template information.
TemplateId	string	The template ID.	**20b48fb04483915d4f2cd8ac**
Name	string	The template name.	Cloud editing template
Type	string	The templatetype. Valid values: Timeline : Standard template. VETemplate : Advanced template.	Timeline
Config	string	The template configuration.	Refer to Timeline template configuration details
PreviewMedia	string	The preview media.	**20b48fb04483915d4f2cd8ac**
Status	string	The template status. Valid values: ProcessFailed : Advanced template analysis failed. UploadFailed : Upload failed. Available : Normal. Uploading : Uploading. Created : Created but not yet available. Processing : Advanced template analysis in progress.	Available
CreateSource	string	The creation source. Valid values: AliyunConsole : Created in the Alibaba Cloud console. WebSDK : Created by using WebSDK. OpenAPI : Created by using OpenAPI.	OpenAPI
ModifiedSource	string	The modification source. Valid values: AliyunConsole : Created in the Alibaba Cloud console. WebSDK : Created by using WebSDK. OpenAPI : Created by using OpenAPI.	OpenAPI
PreviewMediaStatus	string	The preview media status. Valid values: PrepareFail : Media analysis failed. Init : Media initialization. Normal : Normal. Preparing : Media analysis in progress.	Normal
CreationTime	string	The creation time. The time is in ISO 8601 format and uses UTC (ending with Z).	2020-12-26T04:11:10Z
ModifiedTime	string	The modification time. The time is in ISO 8601 format and uses UTC (ending with Z).	2020-12-26T04:11:10Z
CoverURL	string	The cover URL.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
ClipsParam	string	The editing 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 to 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\"}"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.