Use SubmitDynamicImageJob to create frame animations - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Usage notes

This is an asynchronous operation. After you submit a task, the task ID is returned. The task is queued for asynchronous execution in the background. You can receive the final result through a callback notification or proactively query the task status by calling Get task details.
You can submit an animated image job only for videos in the UploadSucc, Transcoding, Normal, Checking, or Blocked state.
Animated image production is billed as video transcoding at the same rate, based on resolution and duration. For more information, see Media transcoding billing.

QPS limit

The QPS limit for a single user on this operation is 30 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately. For more information, see QPS limit.

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

vod:SubmitDynamicImageJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	The video ID. You can obtain the video ID by using one of the following methods: Log on to the ApsaraVideo VOD console and choose Media Assets > Audio/Video to view the video ID. Obtain the video ID from the value of the VideoId parameter returned by the CreateUploadVideo operation when you obtain the upload URL and credential. After the video is uploaded, obtain the video ID from the value of the VideoId parameter returned by the SearchMedia operation.	7d2fbc3e273441bdb0e08e55f8****
DynamicImageTemplateId	string	Yes	The ID of the animated image template.	1a443dc52ef10abc4794d700*****
OverrideParams	string	No	The override parameters in the JSON format. For more information, see OverrideParams. You can use this parameter to override the parameters in the animated image template. For more information, see DynamicImageTemplateConfig.	{"Watermarks":[{"Content":"UserID: 666","WatermarkId":"8ca03c884944bd05efccc312367**"}]}

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-74A6-BEF6-D7393642****
DynamicImageJob	object	The information about the animated image job.
JobId	string	The ID of the animated image job.	ad90a501b1bfb72374ad0050746****

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-74A6-BEF6-D7393642****",
  "DynamicImageJob": {
    "JobId": "ad90a501b1bfb72374ad0050746****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.