doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0096.html

Querying a System Task

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.

Request

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.

Response

Table 3 Response parameters

Parameter	Mandatory	Type	Description
id	Yes	String	Task ID.
name	Yes	String	Name of the task.
startTime	Yes	Long	Start time.
endTime	No	Long	End time.
lastUpdate	Yes	Long	Time when the task was last updated.
status	Yes	String	Task status. RUNNING SUCCESSFUL FAILED
message	No	String	Task information.
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	Name of the subtask.
startTime	Yes	Long	Start time.
endTime	No	Long	End time.
lastUpdate	Yes	Long	Time when the task was last updated.
status	Yes	String	Task status. RUNNING SUCCESSFUL FAILED

Example

After the solution is imported successfully, query the task information.

• Request

  GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/systemTasks/008aae2e675d3bcb01675d40ab3f0005

• Success Response

  {
  "endTime":1543457514000,
  "id":"008aae2e675d3bcb01675d3c66f20000",
  "lastUpdate":1543457514000,
  "name": "Import the solution from OBS path obs://aaaaa/traffic.zip.",
  "startTime":1543457499000,
  "status":"SUCCESSFUL",
  "subtasks":[
  {
  "id":"008aae2e675d3bcb01675d3c9f5f0002",
  "lastUpdate":1543457513000,
  "name": "Import the job_batch job.",
  "status":"SUCCESSFUL",
  }
  ]
  }

• Failure response

  HTTP status code 400

  {
      "error_code":"DLF.0810",
      "error_msg":"Task does not exist"
  }

Parent topic: APIs to Be Taken Offline