Queries information about an asynchronous task. Intelligent Media Management (IMM) has multiple asynchronous data processing capabilities, each of which has its own operation for creating tasks. For example, you can call the CreateFigureClusteringTask operation to create a face clustering task and the CreateFileCompressionTask operation to create a file compression task. The GetTask operation is a general operation. You can call this operation to query information about asynchronous tasks by task ID or type.
Operation description
Before you call this operation, make sure that you are familiar with the billing of IMM.
Debugging
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|---|---|---|---|---|
| imm:GetTask | get | *Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectName | string | Yes | The name of the project. You can obtain the name of the project from the response of the CreateProject operation. | immtest |
| TaskType | string | Yes | The type of the task. For information about valid values, see Task types. | VideoLabelClassification |
| TaskId | string | Yes | The ID of the task. You can obtain the ID of a task after you create the task. | c2b277b9-0d30-4882-ad6d-ad661382**** |
| RequestDefinition | boolean | No | Specifies whether to return the initial request parameters that are used to create the task. Default value: False. | True |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "2C5C1E0F-D8B8-4DA0-8127-EC32C771****",
"ProjectName": "immtest",
"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": "VideoLabelClassification",
"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
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-05-11 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |