ListWorkflowTasks-Intelligent Media Services(IMS)-阿里云帮助中心

Retrieves workflow tasks.

Operation description

This API only returns data from the last 90 days.

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

list

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkflowId	string	No	The ID of the workflow template.	****b4fb044839815d4f2cd8****
WorkflowName	string	No	The name of the workflow template.	example-workflow-****
KeyText	string	No	A keyword for fuzzy matching against the TaskInput, such as a file name or Media ID. Max length: 32 characters.	****7aa4cc4459ada8ef35f7** 或 TestVideo***.flv
StartOfCreateTime	string	No	The start of the time range for filtering tasks by their creation time. Supports querying data from the last 90 days only.	2025-07-12T00:00:00Z
EndOfCreateTime	string	No	The end of the time range for filtering tasks by their creation time. Supports querying data from the last 90 days only.	2025-07-15T00:00:00Z
MaxResults	integer	No	The maximum number of media workflow instances to return. Valid values: 1 to 100. Default value: 10.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.	************VRpbWUQARgBIpcBCgkA1bUtaAAAAAAKiQEDhAAAADFTMzg2NTY2NjU2MzM3NjU2NjYyMzkzMTYyMzI2MjYzNjY2********

Response elements

Element	Type	Description	Example
	object	Schema of Response
TotalCount	integer	The total number of entries returned. By default, this parameter is not returned.	4
RequestId	string	The ID of the request.	C0C02296-113C-5838-8FE9-8F3A32998DDC
NextToken	string	A pagination token.	****8EqYpQbZ6Eh7+Zz8DxVYoQ==
TaskList	array<object>	The media workflow tasks.
	array<object>	The details of a workflow task.
TaskId	string	The ID of the workflow task.	***4c93d2f404f8345b16a965***
TaskInput	string	The input data for the workflow task.	{\"Type\":\"Media\",\"Media\":\"**8b40884171efb0d9e7f7f458**\"}
Status	string	The task state. Valid values: Init: Initializing Failed Canceled Processing Succeed	Succeed
CreateTime	string	The time the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-07-15T09:45:48Z
FinishTime	string	The time the task was completed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-12-07T10:53:45Z
Workflow	object	The information about the workflow template.
WorkflowId	string	The workflow ID.	****2491c84dce913da9fe65****
Name	string	The name of the workflow template.	example-workflow-***
Status	string	The status of the workflow template.	Active
Type	string	The type of the workflow template.	Common
CreateTime	string	The creation time of the workflow template.	2025-03-21T01:48:49Z
ModifiedTime	string	The last modification time of the workflow template.	2025-02-23 10:19:37 +0800
MediaType	string	The source of the media file. Valid values: OSS: an OSS object. Media: a media asset.	OSS
UserData	string	The custom data that was passed when the task was submitted.	{"NotifyAddress":"http://xx.xx.xxx"}
MaxResults	integer	The maximum number of entries returned in this response.	10

Examples

Success response

JSON format

{
  "TotalCount": 4,
  "RequestId": "C0C02296-113C-5838-8FE9-8F3A32998DDC",
  "NextToken": "****8EqYpQbZ6Eh7+Zz8DxVYoQ==",
  "TaskList": [
    {
      "TaskId": "*****4c93d2f404f8345b16a965*****",
      "TaskInput": "{\\\"Type\\\":\\\"Media\\\",\\\"Media\\\":\\\"****8b40884171efb0d9e7f7f458****\\\"}",
      "Status": "Succeed",
      "CreateTime": "2024-07-15T09:45:48Z",
      "FinishTime": "2024-12-07T10:53:45Z",
      "Workflow": {
        "WorkflowId": "******2491c84dce913da9fe65******",
        "Name": "example-workflow-***",
        "Status": "Active",
        "Type": "Common",
        "CreateTime": "2025-03-21T01:48:49Z",
        "ModifiedTime": "2025-02-23 10:19:37 +0800",
        "MediaType": "OSS"
      },
      "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\"}"
    }
  ],
  "MaxResults": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.