Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs/ Job Development APIs/ Querying System Task Details
Updated on 2025-11-17 GMT+08:00
View PDF

Querying System Task Details

Function

This API is used to query details about asynchronous tasks.

URI

  • URI format

    GET /v1/{project_id}/system-tasks/{task_id}

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain a project ID, see Project ID and Account ID.

    task_id

    Yes

    String

    Task ID. For details about how to obtain the ID, see the response parameters in Importing a Job.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

workspace

No

String

Workspace ID.

  • If this parameter is not set, data in the default workspace is queried by default.
  • To query data in other workspaces, this header must be carried.
    NOTE:
    • You need to specify a workspace for multiple DataArts Studio instances.
    • This parameter is mandatory if no default workspace is available. If you do not set it, an error is reported.

Response Parameters

Table 3 Response parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Task ID

name

Yes

String

Task name

startTime

Yes

Long

Start time

endTime

No

Long

End time

lastUpdate

Yes

Long

Update time

status

Yes

String

Status

  • RUNNING
  • SUCCESSFUL
  • FAILED

projectId

No

String

Project ID

subtasks

No

List<SubTask>

Subtask. For details, see Table 4.
Table 4 subtasks parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Subtask ID

name

Yes

String

Subtask name

lastUpdate

Yes

Long

Update time

status

Yes

String

Status

  • RUNNING
  • SUCCESSFUL
  • FAILED

taskId

No

String

Task information

Example Request

Query the task for exporting a job. 
GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/systemTasks/008aae2e675d3bcb01675d40ab3f0005

Example Response

  • Success response 
    {
    "endTime": 1544777083000,
    "id": "008aae2e67abe2ff0167abe3a28f0000",
    "lastUpdate": 1544777083000,
"name": "Import the job from obs://aaaaa/job_batch.zip.",
    "projectId": "b384b9e9ab9b4ee8994c8633aabc9505",
    "startTime": 1544777081000,
    "status": "SUCCESSFUL",
    "subtasks": [
        {
            "id": "008aae2e67abe2ff0167abe3a7e70002",
            "lastUpdate": 1544777083000,
"name": "Import the job_batch job.",
            "status": "SUCCESSFUL",
            "taskId": "008aae2e675d3bcb01675d40ab3f0005"
        }
    ]
}
  • Failure response

    HTTP status code 400

    {
    "error_code":"DLF.20810",
    "error_msg":"Task[008aae2e675d3bcb01675d40ab3f0005] does not exist"
}
Parent Topic: Job Development APIs