DocsICP FilingConsole
Documentation
Home Page Intelligent Media Services Developer Reference API Reference API catalog Miscellaneous UpdateTemplate

UpdateTemplate

Updated at:
Copy as MD
Product
My Favorites

Modifies a cloud editing template, including the template title and configuration.

Operation description

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:UpdateTemplate

update

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
TemplateId

string

No

The ID of the cloud editing template. You can obtain the ID from the Intelligent Media Services console or the response parameters of the CreateTemplate operation.

23923ec3318f4c359e42e1e5b296****
Name

string

No

The name of the cloud editing template.

Cloud Clip Template 1
Config

string

No

The template configuration. For more information, see Common template configuration details.

{ "VideoTracks": [ { "VideoTrackClips": [ { "Sys_Type" : "ArrayItems", "Sys_ArrayObject" : "$VideoArray", "Sys_Template" : { "MediaId" : "$MediaId" } } ] } ] }
CoverUrl

string

No

The URL of the template cover.

http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
PreviewMedia

string

No

The ID of the preview video media asset.

1ae320b48fb04483915d4f2cd8ac****
Status

string

No

The template status. Valid values:

  • Available: Normal.

  • Created: Created but unavailable.

  • Uploading: Uploading.

  • Processing: Analyzing the advanced template.

  • UploadFailed: Upload failed.

  • ProcessFailed: Advanced template analysis failed.

Note

After an advanced template is created, it requires analysis time and its status is Processing. The template is unavailable during this period and can only be used when its status changes to Available. The analysis time depends on the template file size and typically ranges from 10 seconds to 5 minutes.

Available
Source

string

No

The update source. Default value: OpenAPI. Valid values:

  • AliyunConsole: Created through the Alibaba Cloud Management Console.

  • OpenAPI: Created through OpenAPI.

  • WebSDK: Created through WebSDK.

OpenAPI
RelatedMediaids

string

No

The media assets associated with the template, used by the common template editor.

{"video":["f64c6acc840247edb6b12f575c66****","9675dcf040ba4525bb037c29d156****"],"audio":["62a54019d9114009a5ae9bcfd70b****"],"image":["743ffbeb7e004c758cdc1fb34c04****"]}

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

F8D475A5-F2EC-5755-ABD8-22D5561C****

Examples

Success response

JSON format

{
  "RequestId": "F8D475A5-F2EC-5755-ABD8-22D5561C****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：SubmitYikeStoryboardJobNext：AddCategory