SubmitDynamicImageJob-阿里云帮助中心

Operation description

Usage notes

This is an asynchronous interface. After you submit a job, the operation returns a job ID and queues it for asynchronous processing. The final result is sent through a callback notification, or you can query the job status by calling the GetDynamicImageJob operation.
You can start a dynamic image job only for videos that are in the Uploaded, Transcoding, Normal, UnderReview, or Blocked state.
The fees for generating dynamic images are included in transcoding costs and are calculated using the same standard, which is based on video resolution and duration. For more information, see media transcoding billing.

QPS limit

The QPS limit for this operation is 30 queries per second (QPS) per user. The system throttles calls that exceed this limit, which may affect your business. Call this operation at a reasonable rate. For more information, see QPS limits.

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 get the video ID in the following ways: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video to view the video ID. The value of the `VideoId` parameter returned by the CreateUploadVideo operation. The value of the `VideoId` parameter returned by the SearchMedia operation, which you can call after the video is uploaded.	7d2fbc3e273441bdb0e08e55f8****
DynamicImageTemplateId	string	Yes	The dynamic image template ID.	1a443dc52ef10abc4794d700*****
OverrideParams	string	No	The override parameters, specified as a JSON string. For more information, see OverrideParams. For details on the settings that can be overridden, see DynamicImageTemplateConfig.	{"Watermarks":[{"Content":"UserID: 666","WatermarkId":"8ca03c884944bd05efccc312367**"}]}

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	25818875-5F78-74A6-BEF6-D7393642****
DynamicImageJob	object	The dynamic image job details.
JobId	string	The dynamic image job ID.	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.