Modifies an online editing template. You can modify the template title and template configurations.
Operation description
- 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:UpdateTemplate | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| TemplateId | string | No | The ID of the online editing template. You can obtain the template ID in the Intelligent Media Services (IMS) console or the response parameters of the AddTemplate operation. | ****20b48fb04483915d4f2cd8ac**** |
| Name | string | No | The name of the online editing template. | |
| Config | string | No | The template configurations. For more information, see Config object of a regular template. | { "VideoTracks": [ { "VideoTrackClips": [ { "Sys_Type" : "ArrayItems", "Sys_ArrayObject" : "$VideoArray", "Sys_Template" : { "MediaId" : "$MediaId" } } ] } ] } |
| CoverUrl | string | No | The URL of the template thumbnail. | http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg |
| PreviewMedia | string | No | The ID of the preview video. | ****20b48fb04483915d4f2cd8ac**** |
| Status | string | No | The template state. Valid values:
Note
After an advanced template is created, it enters the Processing state. In this case, the template is unavailable. The template can be used only when it is in the Available state. The time required for template processing varies based on the size of the template file. Generally, it ranges from 10 seconds to 5 minutes.
| Available |
| Source | string | No | The source from which the template is modified. Default value: OpenAPI. Valid values:
| OpenAPI |
| RelatedMediaids | string | No | The IDs of the materials associated with the template for use by the regular template editor. | {"video":["******c04f1d4a06996144cc1a******","******cb7db64841b159b4f2ea******"],"audio":["******c04f1d4a06996144cc1a******"],"image":["******c04f1d4a06996144cc1a******"]} |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "******11-DB8D-4A9A-875B-275798******"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-11-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |