GetTemplate - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries the information about a template based on the template ID. You can call this operation to query the information about an advanced template if the template is in the Available state.

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:GetTemplate		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	No	The template ID.	**20b48fb04483915d4f2cd8ac**
RelatedMediaidFlag	string	No	Specifies whether to return the information about the associated materials. Default value: 0. Valid values: 0 and 1. A value of 1 specifies that the information about the associated materials is returned. This parameter is valid only for regular templates.	0

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Template	object	The template information.
TemplateId	string	The template ID.	**20b48fb04483915d4f2cd8ac**
Name	string	The template name.
Type	string	The template type. Valid values: Timeline VETemplate	Timeline
Config	string	The template configurations. For more information about the configurations of a regular template, see Config object of a regular template. For more information about the configurations of an advanced template, see Create and use advanced templates.
PreviewMedia	string	The preview media asset.	**20b48fb04483915d4f2cd8ac**
Status	string	The template state. Valid values: Available Created Uploading Processing UploadFailed ProcessFailed	Available
CreateSource	string	The source from which the template was created. Valid values: AliyunConsole OpenAPI WebSDK	OpenAPI
ModifiedSource	string	The source from which the template was modified. Valid values: AliyunConsole OpenAPI WebSDK	OpenAPI
PreviewMediaStatus	string	The state of the preview media asset. Valid values: Init: the initial state, which indicates that the source file is not ready. Preparing: The source file is being prepared. For example, the file is being uploaded or edited. PrepareFail: The source file failed to be prepared. For example, the information about the source file failed to be obtained. Normal: The source file is ready.	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 for submitting a video production job. You can replace mediaId and text with real values to submit a job. References: Create and use a regular template Create and use advanced templates	{"Media1":"mediaId","Text1":"text"}
RelatedMediaids	string	The IDs of the materials associated with the template for use by the regular template editor.	{"video":["****c04f1d4a06996144cc1a**"],"audio":["**c04f1d4a06996144cc1a**"],"image":["**c04f1d4a06996144cc1a****"]}

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Template": {
    "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\"}",
    "RelatedMediaids": "{\"video\":[\"******c04f1d4a06996144cc1a******\"],\"audio\":[\"******c04f1d4a06996144cc1a******\"],\"image\":[\"******c04f1d4a06996144cc1a******\"]}"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history