ListTasks - List tasks by condition | IMM API - Intelligent Media Management

Lists tasks by conditions such as time range or tag.

Operation description

Before you call this operation, familiarize yourself with IMM billing.

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

imm:ListTasks

list

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project.	test-project
TaskTypes	array	No	The task types.
	string	No	The task type. Valid values are listed in Task types.	["OfficeConversion","VideoLabelClassification"]
NextToken	string	No	The pagination token that retrieves the next page of results. If results exceed MaxResults, use the returned NextToken value in the next request. The next call to the operation returns results lexicographically after the NextToken parameter value. Note Leave empty for the first request.	MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
MaxResults	integer	No	The maximum number of results to return. Valid value range: (0, 100]. Default value: 100.	1
TagSelector	string	No	The custom tags of tasks.	test=val1
Sort	string	No	The sort field. Valid values: TaskId: sorts the results by task ID. This is the default sort field. StartTime: sorts the results by task start time. StartTime: sorts the results by task end time.	TaskId
Order	string	No	The sort order. Valid values: asc: in ascending order. This is the default value. desc: in descending order. Valid values: asc : desc :	asc
Status	string	No	The task status. Valid values: Running: The task is running. Succeeded: The task is successful. Failed: The task failed. Valid values: Succeeded : Failed : Running :	Succeeded
StartTimeRange	TimeRange	No	The time range for task start time. Only tasks that started within this range are returned.
EndTimeRange	TimeRange	No	The time range for task end time. Only tasks that ended within this range are returned.
RequestDefinition	boolean	No	Whether to include the original task creation request parameters in the response. Default value: False.	True

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	9847E7D0-A9A3-0053-84C6-BA16FFFA726E
ProjectName	string	The name of the project.	immtest
NextToken	string	A pagination token returned only when more results are available. Pass this value in the next request to retrieve the remaining results.	MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
MaxResults	string	The number of results returned.	1
Tasks	array	The tasks.
	TaskInfo	The task details.

Examples

Success response

JSON format

{
  "RequestId": "9847E7D0-A9A3-0053-84C6-BA16FFFA726E",
  "ProjectName": "immtest",
  "NextToken": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==",
  "MaxResults": "1",
  "Tasks": [
    {
      "Status": "Running",
      "Code": "ResourceNotFound",
      "Message": "The specified resource project is not found.",
      "StartTime": "2021-12-24T03:01:41.662060377Z",
      "EndTime": "2021-12-24T03:01:49.480109219Z",
      "UserData": "{\"ID\": \"user1\",\"Name\": \"test-user1\",\"Avatar\": \"http://example.com?id=user1\"}",
      "TaskType": "VideoLabelClassification",
      "TaskId": "c2b277b9-0d30-4882-ad6d-ad661382****",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "TaskRequestDefinition": "{\n\t\"ProjectName\":\"test-project\",\n\t\"CompressedFormat\":\"zip\",\n\t\"TargetURI\":\"oss://test-bucket/output/test.zip\",\n\t\"Sources\":[{\"URI\":\"oss://test-bucket/input/test.jpg\"}]\n}",
      "Progress": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.