DocsICP FilingConsole
Documentation
Home Page Intelligent Media Services Developer Reference API Reference API catalog Media processing Snapshot ListDynamicImageJobs

ListDynamicImageJobs

Updated at:
Copy as MD
Product
My Favorites

Retrieves a list of animated image tasks.

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

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
StartOfCreateTime

string

No

The start time of the creation time filter. The time is in ISO 8601 format and uses UTC (ending with Z).

2022-07-12T00:00:00Z
EndOfCreateTime

string

No

The end time of the creation time filter. The time is in ISO 8601 format and uses UTC (ending with Z).

2022-07-14T00:00:00Z
Status

string

No

The task status.

Valid values:

  • Init :

    Submitted.

  • Success :

    Succeeded.

  • Fail :

    Failed.

Success
OrderBy

string

No

The sort order. Valid values:

  • CreateTimeAsc: Sorts by creation time in ascending order.

  • CreateTimeDesc: Sorts by creation time in descending order.

Valid values:

  • CreateTimeDesc :

    Sorts by creation time in descending order.

  • CreateTimeAsc :

    Sorts by creation time in ascending order.

CreateTimeDesc
JobId

string

No

The task ID.

****cdb3e74639973036bc84****
PageSize

integer

No

The number of entries per page. Default value: 20. Maximum value: 100.

20
NextPageToken

string

No

The mark for the next page during continuous paging in a paged query.

cdb3e74639973036bc84

Response elements

Element

Type

Description

Example

object

PlainResponse<List>

RequestId

string

The request ID.

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

array<object>

The list of tasks.

array<object>

The animated image task information.

JobId

string

The animated image task ID.

****cdb3e74639973036bc84****
TriggerSource

string

The request trigger source.

Valid values:

  • Console :

    Console.

  • Workflow :

    Workflow.

  • API :

    API

API
Name

string

The task name.

SampleJob
Input

object

The task input.

Type

string

The input type. Valid values:

  • OSS: the OSS file URL.

  • Media: the media asset ID.

Valid values:

  • Media :

    The media asset ID.

  • OSS :

    The OSS URL.

OSS
Media

string

The input media. OSS URLs and media asset IDs are supported. OSS URL formats:

  • OSS://bucket/object

  • http(s)://bucket.oss-[regionId].aliyuncs.com/object In the URLs, bucket is the name of the OSS bucket that resides in the same region as the current project, and object is the file path.

oss://bucket/object
Output

object

The task output.

Type

string

The output type. Valid values:

  • OSS: the OSS file URL.

  • Media: the media asset ID.

Valid values:

  • Media :

    The media asset ID.

  • OSS :

    The OSS URL.

Media
Media

string

The output media. If Type is set to OSS, enter an OSS URL. If Type is set to Media, enter a media asset ID. OSS URL formats:

  • OSS://bucket/object

  • http(s)://bucket.oss-[RegionId].aliyuncs.com/object In the URLs, bucket is the name of the OSS bucket that resides in the same region as the current project, and object is the file path.

****cdb3e74639973036bc84****
TemplateId

string

The template ID.

****cdb3e74639973036bc84****
PipelineId

string

The pipeline ID.

****cdb3e74639973036bc84****
Status

string

The task status.

  • Success: Succeeded.

  • Fail: Failed.

  • Init: Submitted.

Valid values:

  • Init :

    Submitted.

  • Success :

    Succeeded.

  • Fail :

    Failed.

Success
SubmitTime

string

The task submission time. The time is in ISO 8601 format and uses UTC (ending with Z).

2022-07-12T16:17:54Z
FinishTime

string

The task completion time. The time is in ISO 8601 format and uses UTC (ending with Z).

2022-07-12T16:30:54Z
CreateTime

string

The creation time. The time is in ISO 8601 format and uses UTC (ending with Z).

2022-07-12T16:17:54Z
ModifiedTime

string

The last modification time. The time is in ISO 8601 format and uses UTC (ending with Z).

2022-07-12T16:30:54Z
NextPageToken

string

The pagination token for the next page.

****cdb3e74639973036bc84****

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Jobs": [
    {
      "JobId": "****cdb3e74639973036bc84****",
      "TriggerSource": "API",
      "Name": "SampleJob",
      "Input": {
        "Type": "OSS",
        "Media": "oss://bucket/object"
      },
      "Output": {
        "Type": "Media",
        "Media": "****cdb3e74639973036bc84****"
      },
      "TemplateId": "****cdb3e74639973036bc84****",
      "PipelineId": "****cdb3e74639973036bc84****",
      "Status": "Success",
      "SubmitTime": "2022-07-12T16:17:54Z",
      "FinishTime": "2022-07-12T16:30:54Z",
      "CreateTime": "2022-07-12T16:17:54Z",
      "ModifiedTime": "2022-07-12T16:30:54Z"
    }
  ],
  "NextPageToken": "****cdb3e74639973036bc84****\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：ListSnapshotJobsNext：Media information