DocsICP FilingConsole
官方文档
首页

UpdateTemplate

更新时间：
复制 MD 格式
产品详情
我的收藏

Modifies an online editing template. You can modify the template title and template configurations.

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

*All Resource

*

 None 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.

23923ec3318f4c359e42e1e5b296****
Name

string

No

The name of the online editing template.

Cloud Editing Template 1
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.

1ae320b48fb04483915d4f2cd8ac****
Status

string

No

The template state. Valid values:

  • Available: The template is available.

  • Created: The template is created but not ready for use.

  • Uploading: The video is being uploaded.

  • Processing: The advanced template is being processed.

  • UploadFailed: Failed to upload the video.

  • ProcessFailed: Failed to process the advanced template.

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:

  • AliyunConsole

  • OpenAPI

  • WebSDK

OpenAPI
RelatedMediaids

string

No

The IDs of the materials associated with the template for use by the regular 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.