Querying Details About a Processing Task
Function
This API is used to obtain details about processing tasks, including feature analysis tasks and data processing tasks. You can specify the task_id parameter to obtain the details about a specific task.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v2/{project_id}/processor-tasks/{task_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. |
task_id |
Yes |
String |
ID of a data processing task. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
create_time |
Long |
Time when a data processing task is created. |
data_source |
ProcessorDataSource object |
Input of a data processing task. Either this parameter or inputs is delivered. |
description |
String |
Description of a data processing task. |
duration_seconds |
Integer |
Running time of data processing, in seconds. |
error_msg |
String |
Error message. This field is displayed when the value of status is 3. |
inputs |
Array of ProcessorDataSource objects |
Input channel list of a data processing task. Either this parameter or data_source is delivered. |
is_current |
Boolean |
Whether the current task is the latest of the same type of this version. |
name |
String |
Name of a data processing task. |
result |
Object |
Output result of a data processing task. This field is displayed when status is set to 2 and is valid for a feature analysis task. |
status |
Integer |
Status of a data processing task. Options:
|
task_id |
String |
ID of a data processing task. |
template |
TemplateParam object |
Data processing template, such as the algorithm ID and parameters. |
version_count |
Integer |
Version number of a data processing task. |
version_id |
String |
Dataset version ID corresponding to a data processing task. |
version_name |
String |
Dataset version name corresponding to a data processing task. |
work_path |
WorkPath object |
Working directory of a data processing task. |
workspace_id |
String |
Workspace ID of a data processing task. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Dataset name. |
source |
String |
Data source path. Options:
|
type |
String |
Data source type. Options:
|
version_id |
String |
Version of a dataset. |
version_name |
String |
Dataset version name. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Task type, which is the ID of a data processing template. Options:
|
name |
String |
Template name. |
operator_params |
Array of OperatorParam objects |
Operator parameter list. |
Parameter |
Type |
Description |
---|---|---|
advanced_params_switch |
Boolean |
Advanced parameter switch. |
id |
String |
ID of an operator. |
name |
String |
Name of an operator. |
params |
Object |
Operator parameter. The parameter type is map<string,object>. Currently, object only supports the types of Boolean, Integer, Long, String, List[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] and Map<String,String>. For two special scenarios of object detection and image classification in a data preprocessing task, the value of task_type is object_detection or image_classification. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Dataset name. |
output_path |
String |
Output path, for example, /datasets/demo. |
path |
String |
Working path. Options:
|
type |
String |
Type of a working path. Options:
|
version_id |
String |
Version of a dataset. |
version_name |
String |
Name of a dataset version. The value can contain 0 to 32 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed. |
Example Requests
Querying Details About a Data Processing Task
GET https://{endpoint}/v2/{project_id}/processor-tasks/{task_id}
Example Responses
Status code: 200
OK
{ "task_id" : "AcYfsdfhGyrWL5TtahH", "name" : "V002", "data_source" : { "type" : "DATASET", "source" : "X6c3N3eztX7cr3Arvqu" }, "inputs" : [ { "type" : "DATASET", "source" : "X6c3N3eztX7cr3Arvqu" } ], "template" : { "id" : "sys_data_analyse", "name" : "data analyse template name", "operator_params" : [ { "id" : "sys_data_analyse", "params" : { "op_list" : [ ], "task_type" : "image_classification", "manifest_path" : "s3://lch-test-obs/classify/output/dataset-3026-X6c3N3eztX7cr3Arvqu/annotation/V002/V002.manifest", "file_path" : "s3://lch-test-obs/classify/output/dataset-3026-X6c3N3eztX7cr3Arvqu/annotation/evaluation/V002", "is_normed" : false } } ] }, "status" : 2, "duration_seconds" : 22, "create_time" : 1606373999627, "result" : "xxx", "version_id" : "XwTuRqI9En7xuZskW70", "is_current" : true }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot