SubmitDynamicImageJob - ApsaraVideo VOD

Submits a frame animation job and starts asynchronous processing.

Operation description

You can capture a part of a video and generate animated images only when the video is in the Uploaded, Transcoding, Normal, Reviewing, or Flagged state.
The fees for frame animation are included in your video transcoding bill. You are charged based on the output resolution and the duration. For more information, see Billing of basic services.

QPS limits

You can call this operation up to 30 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on API operations.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	The ID of the video. You can use one of the following methods to obtain the ID: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the Video and Audio page, view the ID of the media file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console. Obtain the value of VideoId from the response to the CreateUploadVideo operation that you call to upload media files. Obtain the value of VideoId from the response to the SearchMedia operation after you upload media files.	7d2fbc3e273441bdb0e08e55f8****
DynamicImageTemplateId	string	Yes	The ID of the frame animation template.	1a443dc52ef10abc4794d700*****
OverrideParams	string	No	The override parameter. Specify the value in the JSON format. For more information, see Parameters for media processing. You can use this parameter to override configurations in the animated image template. For more information, see the "DynamicImageTemplateConfig: the configurations of an animated sticker template" section of the Basic data types topic.	{"Watermarks":[{"Content":"UserID: 666","WatermarkId":"8ca03c884944bd05efccc312367**"}]}

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The ID of the request.	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

Sample success responses

JSONformat

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

Error codes

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