获取任务列表信息
分页查询 NineData 工作流任务列表,支持根据任务类型、数据源、用户视角、状态、时间等条件过滤。
请求地址:/openapi/v1/workflow/list
请求方法:GET
请求参数
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| module | String | 是 | 任务类型:
| sqlTask |
| datasourceId | String | 否 | 数据源 ID。 | ds-dbiddumxp4h |
| accountId | String | 否 | 用户 ID。 | 1238779494193071 |
| accountType | String | 否 | 查询用户类型:
| submitter |
| status | String | 否 | 任务状态。
| notStarted |
| keyword | String | 否 | 关键字:任务名称、任务 ID。 | test |
| startTime | String | 否 | 任务创建时间:起始,格式:yyyy-MM-dd'T'HH:mm:ssZ。 | 2022-09-11T12:34:56Z |
| endTime | String | 否 | 任务创建时间:结束,格式:yyyy-MM-dd'T'HH:mm:ssZ。 | 2022-09-11T12:34:56Z |
| current | Integer | 是 | 当前页码,从 1 开始,默认 1。 | 1 |
| pageSize | Integer | 是 | 每页大小,默认 10。 | 10 |
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Boolean | 请求是否成功。 | true |
| data | Array | 任务列表。 | 无 |
| └name | String | 任务名称。 | "test task" |
| └workflowId | String | 任务 ID。 | "st-d5e200daj7wk" |
| └createTime | String | 任务创建时间。 | "2022-09-11T12:34:56Z" |
| └module | String | 任务类型。 | sqlTask |
| └submitter | String | 任务提交人 ID。 | "1238779494193071" |
| └status | String | 任务状态。 | notStarted |
| └datasourceId | String | 任务关联的数据源 ID。 | "ds-dbiddumxp4h" |
| └dbGroupId | String | 任务关联的数据库分组 ID。 | "group1" |
| └dbName | String | 任务关联的数据库名称。 | "ght" |
| └schemaName | String | 任务关联的 Schema 名称。 | "public" |
| errorCode | String | 错误码。 | 无 |
| message | String | 异常信息。 | 无 |
| current | Integer | 当前页码。 | 1 |
| pageSize | Integer | 每页大小。 | 10 |
| total | Integer | 总记录数。 | 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
}