文档首页> 数据治理中心 DataArts Studio> API参考（吉隆坡区域）> 数据开发API> 待下线API> 查询系统任务
更新时间：2023-06-15 GMT+08:00
查看PDF

查询系统任务

功能介绍

本接口用于查询异步任务详情。

URI

  • URI格式

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

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号，获取方法请参见项目ID和帐号ID。

    task_id

    是

    String

    任务ID

请求消息

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

  • 如果不设置该参数，默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据，需要带上该消息头。

响应消息

表3 参数说明

参数名

是否必选

参数类型

说明

id

是

String

任务ID

name

是

String

任务名称

startTime

是

Long

开始时间

endTime

否

Long

结束时间

lastUpdate

是

Long

更新时间

status

是

String

状态:

  • RUNNING
  • SUCCESSFUL
  • FAILED

message

否

String

任务消息

subtasks

否

List<SubTask>

子任务，参考表4
表4 SubTask参数说明

参数名

是否必选

参数类型

说明

id

是

String

子任务ID

name

是

String

子任务名称

startTime

是

Long

开始时间

endTime

否

Long

结束时间

lastUpdate

是

Long

更新时间

status

是

String

状态:

  • RUNNING
  • SUCCESSFUL
  • FAILED

示例1

导入解决方案成功，查询任务信息。

  • 请求
    GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/system-tasks/008aae2e675d3bcb01675d3c66f20000
  • 响应
    {
{
"endTime":1543457514000,
"id":"008aae2e675d3bcb01675d3c66f20000",
"lastUpdate":1543457514000,
"name":"从OBS路径[obs://aaaaa/traffic.zip]导入解决方案。",
"projectId":"b384b9e9ab9b4ee8994c8633aabc9505",
"startTime":1543457499000,
"status":"SUCCESSFUL",
"subtasks":[
{
"id":"008aae2e675d3bcb01675d3c9f5f0002",
"lastUpdate":1543457513000,
"name":"导入作业[job_batch]。",
"status":"SUCCESSFUL",
"taskId":"008aae2e675d3bcb01675d3c66f20000"
},
{
"id":"008aae2e675d3bcb01675d3c9fdc0003",
"lastUpdate":1543457513000,
"name":"导入作业[job_stream]。",
"status":"SUCCESSFUL",
"taskId":"008aae2e675d3bcb01675d3c66f20000"
}
]
}

示例2

导入解决方案失败，查询任务信息。

  • 请求
    GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/systemTasks/008aae2e675d3bcb01675d3e6b960004
  • 响应
    {
"endTime":1543457631000,
"id":"008aae2e675d3bcb01675d3e6b960004",
"lastUpdate":1543457631000,
"message":"读取OBS文件[obs://aaaaa/traffic2.zip]失败。",
"name":"从OBS路径[obs://aaaaa/traffic2.zip]导入解决方案。",
"projectId":"b384b9e9ab9b4ee8994c8633aabc9505",
"startTime":1543457631000,
"status":"FAILED",
"subtasks":[]
}

示例3

查询启动解决方案的任务。

  • 请求
    GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/systemTasks/008aae2e675d3bcb01675d40ab3f0005
  • 响应
    {
"endTime":1543457794000,
"id":"008aae2e675d3bcb01675d40ab3f0005",
"lastUpdate":1543457794000,
"name":"启动解决方案[traffic]",
"projectId":"b384b9e9ab9b4ee8994c8633aabc9505",
"startTime":1543457778000,
"status":"FAILED",
"subtasks":[
{
"id":"008aae2e675d3bcb01675d40e8560006",
"lastUpdate":1543457794000,
"name":"启动作业[job_batch]",
"status":"FAILED",
"taskId":"008aae2e675d3bcb01675d40ab3f0005"
}
]
}

示例4

查询导出作业的任务。

  • 请求
    GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/systemTasks/008aae2e675d3bcb01675d40ab3f0005
  • 响应
    {
"endTime": 1544777083000,
"id": "008aae2e67abe2ff0167abe3a28f0000",
"lastUpdate": 1544777083000,
"name": "从路径[obs://aaaaa/job_batch.zip]导入作业。",
"projectId": "b384b9e9ab9b4ee8994c8633aabc9505",
"startTime": 1544777081000,
"status": "SUCCESSFUL",
"subtasks": [{
"id": "008aae2e67abe2ff0167abe3a7e70002",
"lastUpdate": 1544777083000,
"name": "导入作业[job_batch]。",
"status": "SUCCESSFUL",
"taskId": "008aae2e67abe2ff0167abe3a28f0000"
}]
}
  • 失败响应

    HTTP状态码 400

    {
    "error_code":"DLF.0810",
    "error_msg":"Task does not exist"
}
父主题： 待下线API