获取工作流实例列表

更新时间：2025-12-16

接口描述

根据指定的筛选条件获取指定工作空间下采用游标分页的工作流实例信息列表

权限说明

用户获取工作空间下工作流实例列表，需具有以下任一权限

查看工作流的权限: 查看VIEW
运行工作流的权限: 运行EXECUTE
编辑工作流的权限：编辑MODIFY
管理工作流的权限：管理MANAGE

注意事项

无

请求结构

Plain Text

1GET /v2/workspaces/{workspaceId}/job/run HTTP/1.1
2Host: databuilder.bd.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域

请求参数

参数名	类型	是否必填	参数位置	说明
`workspaceId`	`String`	是	Path参数	工作空间ID，不允许为空或者只包含空白字符
`marker`	`String`	否	Query参数	游标，在获取第一页数据时不填，后续根据情况从请求响应中的`nextPageMarker`(下一页游标)以及`prevPageMarker`(上一页游标)选择一个进行填充，并且在填充前需要对游标值做URL Encoding。
`limit`	`int`	否	Query参数	每页展示多少条数据，默认为50条
`jobIds`	`Array`	否	Query参数	表示工作流实际对应的工作流ID，支持填入多个工作流ID，多个工作流ID之间用逗号隔开, 例如`jobIds=jid_1,jid_2`无默认值，即在不提供该参数时不根据工作流ID进行过滤。
`orderBy`	`String`	否	Query参数	工作流实例排序字段，目前该字段的值仅支持：工作流实例的开始时间: `startTime`工作流实例结束的时间: `endTime`默认值为`startTime`
`order`	`String`	否	Query参数	工作流实例排序顺序，支持：`desc`: 按降序排序`asc`: 按升序排序默认为`desc`
`statuses`	`String`	否	Query参数	工作流实例状态，允许填入多个进行筛选，多个状态之间用逗号隔开，例如：`statuses=INIT,STOP`目前支持根据如下的状态进行筛选：`INIT`：初始化`RUNNING_EXECUTION`：运行中`READY_PAUSE`：准备暂停`PAUSE`：已暂停`READY_STOP`：准备停止`STOP`：已停止`SUBMIT_FAILURE`：提交失败`SUCCESS`：运行成功**`FAILURE`: 失败`SERIAL_WAIT`：串行等待无默认值，即在不提供该参数时不根据工作流实例状态进行过滤。
`triggerTypes`	`String`	否	Query参数	工作流的触发类型，允许填入多个进行筛选，多个触发类型之间用逗号隔开，例如：`triggerTypes=SINGLE,SCHEDULE`目前支持：`SINGLE`: 单次手动执行`SCHEDULE`：定时调度**`BACKFILL`：补数据执行无默认值，即在不提供该参数时不根据工作流触发类型进行过滤。
`startTimeFrom`	`String`	否	Query参数	工作流实例启动时间范围的起始值，为UTC 格式的时间，比如`2025-11-15T00:00:00Z`。且`startTimeFrom`与`startTimeTo`需要成对出现。此外，当`startTimeFrom`与`startTimeTo`都没有提供时，会默认获取最近三天(包括今天)内的工作流实例。
`startTimeTo`	`String`	否	Query参数	工作流实例启动时间范围的终止值，为UTC 格式的时间，比如`2025-11-15T23:59:59Z`。且`startTimeFrom`与`startTimeTo`需要成对出现此外，当`startTimeFrom`与`startTimeTo`都没有提供时，会默认获取最近三天(包括今天)内的工作流实例。
`endTimeFrom`	`String`	否	Query参数	工作流实例结束时间范围的起始值，为UTC 格式的时间，比如`2025-11-16T00:00:00Z`。且`endTimeFrom`与`endTimeTo`需要成对出现。当`endTimeFrom`与`endTimeTo`都没有提供时，不会提供默认时间范围。
`endTimeTo`	`String`	否	Query参数	工作流实例结束时间范围的终止值，为UTC 格式的时间，比如`2025-11-16T23:59:59Z`。且`endTimeFrom`与`endTimeTo`需要成对出现。当`endTimeFrom`与`endTimeTo`都没有提供时，不会提供默认时间范围。
`userIds`	`Array`	否	Query参数	操作人用户ID, 支持填入多个用户ID进行筛选，例如`userIds=userId1,userId2`无默认值，即在不提供该参数时不根据操作人进行过滤。

响应头域

除公共头域外，无其它特殊头域

响应参数

参数名称	类型	描述
`requestId`	`String`	请求ID
`code`	`String`	响应码
`message`	`String`	响应描述信息
`result`	`ListJobInstanceResult`	工作流实例详情

ListJobInstanceResult

字段名	类型	描述
`nextPageMarker`	`String`	下一页游标，如果已经没有后续数据，则不会返回该字段
`prevPageMarker`	`String`	上一页游标，如果目前获取到是第一页的数据，则不会返回该字段
`jobRuns`	`Array`	工作流实例列表

ListJobInstanceResult.JobRun

字段名	类型	描述
`jobInstanceId`	`String`	工作流实例ID
`workspaceId`	`String`	工作流实例归属的工作空间的ID
`jobId`	`String`	工作流实例关联的工作流ID
`jobName`	`String`	工作流实例关联的工作流名称
`status`	`String`	工作流实例状态
`errorMsg`	`String`	工作流实例运行异常时的异常信息
`triggerType`	`String`	工作流实例的触发方式
`scheduleTime`	`String`	工作流实例实际开始调度的时间
`startTime`	`String`	工作流实例开始运行的时间
`endTime`	`String`	工作流实例结束运行的时间
`runUserName`	`String`	触发工作流运行的用户的名称
`runUserId`	`String`	触发工作流运行的用户的ID
`durationSec`	`String`	工作流实例运行时长，单位为秒
`globalParams`	`Array`	工作流实例全局参数列表
`privileges`	`Array`	当前用户对于工作流实例所具备的权限点
`priority`	`String`	工作流实例运行优先级
`executionType`	`String`	工作流执行类型
`maxConcurrency`	`String`	工作流实例执行的最大并发数
`failureStrategy`	`String`	工作流实例的失败策略
`linkFileId`	`String`	工作流实例关联的工作流对应的工作区文件ID

错误码

错误码	错误描述	HTTP状态码	中文解释
`AccessDenied`	无操作权限	403	暂无操作权限

请求示例

Plain Text

1GET https://databuilder.bd.baidubce.com/v2/workspaces/workspace_test/job/runmarker=eyJqb2JJbnN0YW5jZUlkIjoiaW5zX2JiODc4Y2YzMWIxMDU4NTciLCJvcmRlckJ5Q29sdW1uTmFtZSI6InN0YXJ0VGltZSIsImNvbHVtblZhbHVlIjoiMjAyNS0xMS0xOFQxMTozMzozMCIsImluY2x1ZGVDb2x1bW5WYWx1ZSI6ZmFsc2UsIm5leHRQYWdlIjp0cnVlfQ&limit=5&jobIds=jid_test1,jid_test2
2
3X-Region: bd
4X-Via: api-gateway
5Authorization: xxxxxx
6Host: host
7X-Bce-Request-Id: 75f4d4ad-d478-4494-95cd-74449a33365a
8Accept: */*
9Accept-Encoding: gzip, deflate, br
10Connection: keep-alive

响应示例

Plain Text

1HTTP/1.1 200 OK
2Content-Type: application/json
3Transfer-Encoding: chunked
4Date: Mon, 28 Jul 2025 05:36:55 GMT
5Keep-Alive: timeout=180
6Connection: keep-alive
7{
8    "requestId": "920988b9-4482-4d05-8fbe-eb037cf42fa6",
9    "code": "SUCCESS",
10    "result": {
11        "nextPageMarker": "eyJqb2JJbnN0YW5jZUlkIjoiaW5zX2IwZDM2MzVhNDA0MWMxMWQiLCJvcmRlckJ5Q29sdW1uTmFtZSI6InN0YXJ0VGltZSIsImNvbHVtblZhbHVlIjoiMjAyNS0xMS0xOFQxMTozMzoyNiIsImluY2x1ZGVDb2x1bW5WYWx1ZSI6ZmFsc2UsIm5leHRQYWdlIjp0cnVlfQ==",
12        "prevPageMarker": "eyJqb2JJbnN0YW5jZUlkIjoiaW5zX2IwZDM2MzVhNDA0MWMxMWQiLCJvcmRlckJ5Q29sdW1uTmFtZSI6InN0YXJ0VGltZSIsImNvbHVtblZhbHVlIjoiMjAyNS0xMS0xOFQxMTozMzoyNiIsImluY2x1ZGVDb2x1bW5WYWx1ZSI6ZmFsc2UsIm5leHRQYWdlIjpmYWxzZX0=",
13        "jobRuns": [
14            {
15                "jobInstanceId": "ins_test",
16                "workspaceId": "workspace_test",
17                "jobId": "jid_test",
18                "jobName": "job",
19                "status": "SUBMIT_FAILURE",
20                "errorMsg": "Create process definition[jid_b31d4199071da24e] in projectCode=136138134058752 failed",
21                "triggerType": "SINGLE",
22                "scheduleTime": "2025-11-18 11:33:26",
23                "startTime": "2025-11-18 11:33:26",
24                "endTime": "2025-11-18 11:33:27",
25                "runUserName": "user",
26                "runUserId": "e5f88176b7cd431c8f4a4aaf2ed75880",
27                "durationSec": 1,
28                "globalParams": [],
29                "privileges": [
30                    "VIEW",
31                    "EXECUTE",
32                    "MODIFY",
33                    "MANAGE"
34                ],
35                "priority": "MEDIUM",
36                "executionType": "PARALLEL",
37                "maxConcurrency": 1,
38                "failureStrategy": "END",
39                "linkFileId": "file_acdf_7652080bdc6e"
40            }
41        ]
42    }
43}

恢复已暂停的工作流实例

附录

百度智能云

百度千帆·数据智能平台DataBuilder

百度千帆·数据智能平台DataBuilder

获取工作流实例列表

接口描述

权限说明

注意事项

请求结构

请求头域

请求参数

响应头域

响应参数

错误码

请求示例

响应示例