Skip to main content

获取任务列表信息

分页查询 NineData 工作流任务列表,支持根据任务类型、数据源、用户视角、状态、时间等条件过滤。

请求地址:/openapi/v1/workflow/list

请求方法:GET

请求参数

参数类型是否必选说明示例
moduleString任务类型:
  • sqlTask:SQL 任务
  • dataExport:数据导出
sqlTask
datasourceIdString数据源 ID。ds-dbiddumxp4h
accountIdString用户 ID。1238779494193071
accountTypeString查询用户类型:
  • submitter:我提交
  • toApprove:待我审批
  • toExecute:待我执行
  • executed:已执行
  • approved:已审批
submitter
statusString任务状态。
  • notStarted:待启动
  • preChecking:预检查中
  • preCheckSkip:跳过预检查
  • preCheckSuccess:预检查通过
  • preCheckFailed:预检查失败
  • ruleChecking:规则检查中
  • ruleCheckSuccess:规则检查通过
  • ruleCheckFailed:规则检查失败
  • toApprove:待审批
  • approved:审批成功
  • approveRejected:审批被拒绝
  • running:执行中
  • waiting:等待调度
  • scheduling:调度中
  • suspended:已暂停
  • stopped:已终止
  • success:成功
  • failed:失败
  • finished:终止
  • canceled:撤回
  • executeCanceled:撤销执行
  • skipped:跳过
notStarted
keywordString关键字:任务名称、任务 ID。test
startTimeString任务创建时间:起始,格式:yyyy-MM-dd'T'HH:mm:ssZ2022-09-11T12:34:56Z
endTimeString任务创建时间:结束,格式:yyyy-MM-dd'T'HH:mm:ssZ2022-09-11T12:34:56Z
currentInteger当前页码,从 1 开始,默认 1。1
pageSizeInteger每页大小,默认 10。10

返回参数

参数类型说明示例
successBoolean请求是否成功。true
dataArray任务列表。
└nameString任务名称。"test task"
└workflowIdString任务 ID。"st-d5e200daj7wk"
└createTimeString任务创建时间。"2022-09-11T12:34:56Z"
└moduleString任务类型。sqlTask
└submitterString任务提交人 ID。"1238779494193071"
└statusString任务状态。notStarted
└datasourceIdString任务关联的数据源 ID。"ds-dbiddumxp4h"
└dbGroupIdString任务关联的数据库分组 ID。"group1"
└dbNameString任务关联的数据库名称。"ght"
└schemaNameString任务关联的 Schema 名称。"public"
errorCodeString错误码。
messageString异常信息。
currentInteger当前页码。1
pageSizeInteger每页大小。10
totalInteger总记录数。100

调用成功示例

{
"success": true,
"requestId": "Gq7t6KXM-hnmhpRInhiga9BTdghm8OSI",
"data": [{
"createTime": "2025-10-22 07:15:50Z",
"workflowId": "st-ddonzxko8kaz",
"name": "测试快速执行",
"module": "sqlTask",
"submitter": "1030799091781335",
"status": "success",
"datasourceId": "ds-ddduea45j638",
"dbName": "ght"
}, {
"createTime": "2025-10-22 07:15:27Z",
"workflowId": "st-ddonzmqbjtua",
"name": "测试快速执行",
"module": "sqlTask",
"submitter": "1030799091781335",
"status": "failed",
"datasourceId": "ds-ddduea45j638",
"dbName": "ght"
}],
"current": 1,
"pageSize": 10,
"total": 30
}