All Products
Search

This Product

    Intelligent Media Services:SubmitDynamicImageJob

    Document Center

    Intelligent Media Services:SubmitDynamicImageJob

    Last Updated:Sep 11, 2026

    Submits a task to generate an animated image.

    Operation description

    This is an asynchronous operation. After you submit a task, a task ID is returned. At this point, the task is not yet complete and enters a background queue for asynchronous execution. The final result is delivered through a callback notification. You can also proactively query the task status by calling Query animated image task details.

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

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Name

    string

    No

    The task name.

    SampleJob
    Input

    object

    Yes

    The task input.

    Media

    string

    Yes

    The input media.

    • If Type is set to OSS, specify an OSS URL.

    • If Type is set to Media, specify a media asset ID.

    OSS URL format:

    1. oss://bucket/object

    2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object

    In the URL, bucket is the name of the OSS bucket that resides in the same region as the current project, and object is the file path.

    Note

    Before you use the OSS bucket in the URL, add it to IMS storage management.

    oss://bucket/object.mp4
    Type

    string

    Yes

    The input type. Valid values:

    • OSS: an OSS file URL.

    • Media: a media asset ID.

    Valid values:

    • Media :

      media asset ID.

    • OSS :

      OSS URL.

    OSS
    Output

    object

    Yes

    The task output.

    Media

    string

    Yes

    The output media. Both OSS URLs and media asset IDs are supported. OSS URL format:

    • oss://bucket/object

    • http(s)://bucket.oss-[regionId].aliyuncs.com/object

    In the URL, bucket is the name of the OSS bucket that resides in the same region as the current project, and object is the file path.

    Note

    Before you use the OSS bucket in the URL, add it to IMS storage management.

    ****96e8864746a0b6f3****
    Type

    string

    Yes

    The output type. Valid values:

    • OSS: an OSS file URL.

    • Media: a media asset ID.

    Valid values:

    • Media :

      media asset ID.

    • OSS :

      OSS URL.

    Media
    TemplateConfig

    object

    Yes

    The snapshot template configuration.

    OverwriteParams

    object

    No

    The override parameters.

    Format

    string

    No

    The animated image format. Valid values:

    • gif

    • webp

    Valid values:

    • gif :

      gif

    • webp :

      webp

    gif
    Fps

    integer

    No

    The frame rate. Valid values: 1 to 60.

    15
    Height

    integer

    No

    The height of the output animated image. Valid values: 128 to 4096.

    720
    LongShortMode

    boolean

    No

    Specifies whether to enable auto-rotation (long-short side mode). Valid values:

    • true: Enables auto-rotation.

    • false: Disables auto-rotation.

    Default value: true.

    Note

    The width of the transcoding output corresponds to the long side of the input source (the height for portrait videos), and the height corresponds to the short side of the input source (the width for portrait videos).

    Valid values:

    • true :

      true

    • false :

      false

    false
    ScanMode

    string

    No

    The scan mode. Valid values:

    • interlaced: interlaced scan.

    • progressive: progressive scan. This is the default value.

    Valid values:

    • progressive :

      progressive scan.

    • interlaced :

      interlaced scan.

    progressive
    TimeSpan

    object

    No

    The timeline parameters.

    Duration

    string

    No

    The duration.

    • Format: hh:mm:ss[.SSS] or sssss[.SSS].

    • Valid values: [00:00:00.000,23:59:59.999] or [0.000,86399.999].

    01:59:59.999 or 32000.23
    End

    string

    No

    The tail trimming duration, which specifies the length of time to trim from the end. When this parameter is set, the Duration parameter becomes invalid.

    • Format: hh:mm:ss[.SSS] or sssss[.SSS].

    • Valid values: [00:00:00.000,23:59:59.999] or [0.000,86399.999].

    01:59:59.999 or 32000.23
    Seek

    string

    No

    The start time.

    • Format: hh:mm:ss[.SSS] or sssss[.SSS].

    • Valid values: [00:00:00.000,23:59:59.999] or [0.000,86399.999].

    01:59:59.999 or 32000.23
    Width

    integer

    No

    The width of the output animated image. Valid values: 128 to 4096.

    1024
    TemplateId

    string

    Yes

    The template ID.

    ****96e8864746a0b6f3****

    ScheduleConfig

    object

    No

    The scheduling configuration.

    PipelineId

    string

    No

    The pipeline ID.

    ****96e8864746a0b6f3****

    Priority

    integer

    No

    The priority. Valid values: 1 to 10. Default value: 6. A larger value indicates a higher priority.

    6
    UserData

    string

    No

    The custom user data.

    {"SampleKey": "SampleValue"}

    Response elements

    Element

    Type

    Description

    Example

    object

    PlainResponse

    JobId

    string

    The task ID.

    ****20b48fb04483915d4f2cd8ac****
    RequestId

    string

    The request ID.

    ******11-DB8D-4A9A-875B-275798******

    Examples

    Success response

    JSON format

    {
  "JobId": "****20b48fb04483915d4f2cd8ac****",
  "RequestId": "******11-DB8D-4A9A-875B-275798******"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.