ListWorkflowTasks - Intelligent Media Services - Alibaba Cloud Documentation Center

Retrieves workflow tasks.

Operation description

This API only returns data from the last 90 days.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:ListWorkflowTasks	list	All Resources ``	none	none

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.
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 parameters

Parameter	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.
MediaServiceWorkflowTask	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

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.