Query asynchronous task information with GetTask - Intelligent Media Management - Alibaba Cloud - Intelligent Media Management

Queries the information about a specified asynchronous task. Intelligent Media Management (IMM) supports various asynchronous data processing capabilities, each with its own task creation operation, such as CreateFigureClusteringTask for creating figure clustering tasks and CreateFileCompressionTask for creating file compression tasks. This operation is a general-purpose operation that allows you to query the details of an asynchronous task by task ID and type.

Operation description

Before you use this operation, make sure that you are familiar with the billing of Intelligent Media Management and its pricing..

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

get

*Project

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The project name. For information about how to obtain the project name, see Create a project.	immtest
TaskType	string	Yes	The type of the task. For valid values, see Task type list.	FileCompression
TaskId	string	Yes	The ID of the task that you want to query. This value is returned when you create the task.	FileCompression-2f157087-91df-4fda-8c3e-232407ec*****
RequestDefinition	boolean	No	Specifies whether to return the original request parameters used to create the task. Valid values: true false (default) This parameter takes effect only for the following task types: MediaConvert VideoLabelClassification FaceClustering FileCompression ArchiveFileInspection FileUncompression PointCloudCompress ImageToPDF StoryCreation LocationDateClustering ImageSplicing FacesSearching.	true

Response elements

Element	Type	Description	Example
	object	The details of the specified task.
RequestId	string	The request ID.	2C5C1E0F-D8B8-4DA0-8127-EC32C771****
ProjectName	string	The project name.	test-project
EventId	string	The event ID.	2F6-1Bz99Xi93EnRpNEyLudILJm****
Status	string	The running status of the task. Valid values: Running: The task is running. Succeeded: The task is completed. Failed: The task failed.	Running
Code	string	The error code of the task.	ResourceNotFound
Message	string	The error message of the task.	The specified resource project is not found.
StartTime	string	The time when the task started. The value is a UTC timestamp in ISO 8601 format with millisecond precision.	2021-12-24T03:01:41.662060377Z
EndTime	string	The time when the task ended. The value is a UTC timestamp in ISO 8601 format with millisecond precision.	2021-12-24T03:01:49.480109219Z
UserData	string	The custom information specified by the user.	{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
TaskType	string	The type of the task. For valid values, see Task type list.	FileCompression
TaskId	string	The task ID.	c2b277b9-0d30-4882-ad6d-ad661382****
Tags	object	The task tags. These are the tags that the user passed in when creating the task.	{"test": "val1"}
TaskRequestDefinition	string	The original request parameters used to create the task.	{ "ProjectName":"test-project", "CompressedFormat":"zip", "TargetURI":"oss://test-bucket/output/test.zip", "Sources":[{"URI":"oss://test-bucket/input/test.jpg"}] }
Progress	integer	The task progress. Valid values: 0 to 100. Unit: percent (%). Note The GetTask operation does not support this parameter. This parameter is meaningful only when the task status `State` is `Running`.	100

Examples

Success response

JSON format

{
  "RequestId": "2C5C1E0F-D8B8-4DA0-8127-EC32C771****",
  "ProjectName": "test-project",
  "EventId": "2F6-1Bz99Xi93EnRpNEyLudILJm****",
  "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": "FileCompression",
  "TaskId": "c2b277b9-0d30-4882-ad6d-ad661382****",
  "Tags": {
    "test": "val1"
  },
  "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": 100
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.