This API is used to obtain the detailed information of a subtask.
Call description
Request path
GET /api/v1/task/sub_task/{id}
Response parameters
| Parameter | Type | Description |
|---|---|---|
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The amount of time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code. |
| traceId | String | The trace ID of the request. |
| data | Object | For more information, see the data structure of TaskDetailDTO. |
| error | Object | The information about the error that occurred. |
The following table describes the data structure of TaskDetailDTO.
| Parameter | Type | Description |
|---|---|---|
| id | String | The general ID of the subtask. |
| task_id | Integer | The ID of the subtask. |
| name | String | The name of the subtask. |
| state | String | The execution status of the subtask. |
| operator | String | The operation type of the subtask. |
| start_time | Time | The time when the execution of the subtask started. |
| end_time | Time | The time when the execution of the subtask ended. |
| additional_data | NULL | Other data of the subtask. |
| execute_times | Integer | The number of executions. |
| execute_agent | AgentInfo | The agent information of the node that executed the subtask. |
| task_logs | []string | The execution logs. |
Examples
Sample request
GET xxx.xxx.x.x:2886/api/v1/sub_task/12
Sample response
{
"successful": true,
"timestamp": "2024-01-09T21:29:37.372338686+08:00",
"duration": 6,
"status": 200,
"traceId": "638aa02fc5b50051",
"data": {
"id": "12",
"task_id": 2,
"name": "Create local scale out dag",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:03.796683+08:00",
"end_time": "2024-01-09T20:40:03.836712+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "xxx.xxx.x.x",
"port": 2886
},
"task_logs": [
"create local scale out dag success, genericID:22130706433028869"
]
}
}
The sample response displays the details of a subtask named Create local scale out dag. The operation type is RUN, and the execution result is SUCCEED.