All Products
Search

This Product

    ApsaraVideo VOD:GetAIImageJobs

    Document Center

    ApsaraVideo VOD:GetAIImageJobs

    Last Updated:Jul 21, 2026

    Queries the list of AI image processing tasks.

    Operation description

    • Currently, this operation is supported in the following regions: China (Beijing) and China (Shanghai).

    • Call the SubmitAIImageJob operation to submit an AI image processing task before you call this operation to query the list of AI image tasks.

    • You can query up to 10 AI image processing tasks at a time.

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

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    JobIds

    string

    Yes

    The IDs of AI image processing tasks. The value consists of one or more job IDs. A job ID is the value of the JobId parameter returned by the SubmitAIImageJob operation.

    • A maximum of 10 IDs are supported.

    • Separate multiple IDs with commas (,).

    cf08a2c6e11e*****de1711b738b9067

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    7721B494-1F78-4E*****E8-A7CEE7315BFA
    AIImageJobList

    array<object>

    The list of AI image processing tasks.

    object

    The details of an AI image processing task.

    Status

    string

    The task status. Valid values:

    • success: The task is successful.

    • fail: The task failed.

    success
    CreationTime

    string

    The time when the AI image processing task was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

    2020-10-15T03:30:03Z
    AIImageResult

    string

    The OSS URL of the AI image.

    Note

    This is the task result. The URL does not contain complete authentication information. To obtain authentication information, generate it yourself or call the ListAIImage operation to retrieve the media asset result.

    [{"Score":5.035636554444242,"Url":"http://outin-*****.oss-cn-shanghai.aliyuncs.com/357a8748c577*****789d2726e6436aa/image/ai/b0a7612554d*****5cbe3-00001.gif"}]
    VideoId

    string

    The video ID.

    357a8748c577*****789d2726e6436aa
    JobId

    string

    The ID of the AI image processing task.

    cf08a2c6e11e*****de1711b738b9067
    UserData

    string

    The custom settings.

    • The value must be a JSON string.

    • The value must contain the MessageCallback or Extend parameter.

    • The maximum length is 512 bytes.

    For more information about the parameter structure, see UserData.

    {"Extend":{"localId":"****","test":"www"}}
    Code

    string

    The error code.

    Success
    Message

    string

    The error message.

    success
    TemplateConfig

    string

    The snapshot of the configuration information of the specified template when the task was submitted.

    {"Format":"gif","SetDefaultCover":"true"}
    TemplateId

    string

    The AI template ID.

    5a86a00f15194*****d7fe7de1b4a173

    Examples

    Success response

    JSON format

    {
  "RequestId": "7721B494-1F78-4E*****E8-A7CEE7315BFA",
  "AIImageJobList": [
    {
      "Status": "success",
      "CreationTime": "2020-10-15T03:30:03Z",
      "AIImageResult": "[{\"Score\":5.035636554444242,\"Url\":\"http://outin-*****.oss-cn-shanghai.aliyuncs.com/357a8748c577*****789d2726e6436aa/image/ai/b0a7612554d*****5cbe3-00001.gif\"}]",
      "VideoId": "357a8748c577*****789d2726e6436aa",
      "JobId": "cf08a2c6e11e*****de1711b738b9067",
      "UserData": "{\"Extend\":{\"localId\":\"****\",\"test\":\"www\"}}",
      "Code": "Success",
      "Message": "success",
      "TemplateConfig": "{\"Format\":\"gif\",\"SetDefaultCover\":\"true\"}",
      "TemplateId": "5a86a00f15194*****d7fe7de1b4a173"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.