获取工作流
更新时间：2025-08-07
接口描述
通过特定工作空间下获取指定工作流详情
权限说明
用户获取工作空间下特定工作流详情，需具有以下任一权限
- 查看工作流(WORKFLOW)的权限：查看VIEW
- 运行工作流(WORKFLOW)的权限: 运行EXECUTE
- 编辑工作流(WORKFLOW)的权限：编辑MODIFY
- 管理工作流(WORKFLOW)的权限：管理MANAGE
注意事项
- 指定的工作空间不存在，获取工作流详情失败
- 当前用户没有查看工作流的权限，获取工作流详情会失败
- 若指定工作流已经被删除，获取工作流详情会失败
请求结构
Plain Text
1GET /v2/workspaces/{workspaceId}/job/{jobId} HTTP/1.1
2Host: databuilder.bd.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域
请求参数
| 字段名 | 类型 | 是否必填 | 参数位置 | 说明 |
|---|---|---|---|---|
| workspaceId | String | 是 | path参数 | 工作空间ID，不允许为空或者只包含空白字符 |
| jobId | String | 是 | path参数 | 工作流ID，不允许为空或者只包含空白字符 |
响应头域
除公共头域外，无其它特殊头域
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 请求ID |
| code | String | 响应码 |
| message | String | 响应描述信息 |
| result | Job | 工作流详情 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| AccessDenied | 无操作权限 | 403 | 暂无操作权限 |
| IllegalArgument | 参数非法 | 400 | workspace不存在workspaceId未提供非法的maxKeys值 |
| InternalError | 内部错误 | 500 | marker未提供 |
请求示例
Plain Text
1GET https://databuilder.bd.baidubce.com/v2/workspaces/workspace_9862_0763f283d58a/job/jid_800e546b37794884
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": "c02a5770-ab8d-49ab-b6f5-28cc67e55b60",
9 "code": "SUCCESS",
10 "result": {
11 "jobId": "jid_800e546b37794884",
12 "workspaceId": "workspace_9862_0763f283d58a",
13 "name": "xy-sideout-gpu-bbb",
14 "tasks": [
15 {
16 "name": "W_DataFlowTask_0",
17 "id": "tid-1",
18 "description": "desc",
19 "clusterList": [
20 {
21 "clusterId": "compute_9c2f_90d67c4011ed",
22 "engineType": "RAY",
23 "clusterType": "RESIDENT"
24 }
25 ],
26 "compoundTask": {
27 "taskParam": {
28 "parallel": 1
29 },
30 "operators": [
31 {
32 "name": "source",
33 "id": "opid-1",
34 "params": [
35 {
36 "key": "data_path",
37 "value": "bos://databuilder-workflow-dev/data"
38 },
39 {
40 "key": "data_format",
41 "value": "CSV"
42 },
43 {
44 "key": "data_path_type",
45 "value": "BOS_FILE_PATH"
46 }
47 ],
48 "metaData": {
49 "catalogName": "system",
50 "schemaName": "default",
51 "operatorName": "databuilder_location_loader",
52 "version": "v1",
53 "operatorIdentifier": "system_default_databuilder_location_loader_v1"
54 }
55 },
56 {
57 "name": "Processor",
58 "id": "opid-2",
59 "params": [
60 {
61 "key": "process_index",
62 "value": "data_prefix"
63 },
64 {
65 "key": "output_index_left",
66 "value": "left"
67 },
68 {
69 "key": "output_index_right",
70 "value": "right"
71 },
72 {
73 "key": "num",
74 "value": "5"
75 }
76 ],
77 "metaData": {
78 "catalogName": "system",
79 "schemaName": "default",
80 "operatorName": "processor",
81 "version": "v1",
82 "operatorIdentifier": "system_default_processor_v1"
83 },
84 "dependsOn": [
85 "opid-1"
86 ]
87 },
88 {
89 "name": "Adder",
90 "id": "opid-3",
91 "params": [
92 {
93 "key": "add_left",
94 "value": "left"
95 },
96 {
97 "key": "add_right",
98 "value": "right"
99 },
100 {
101 "key": "index_name",
102 "value": "add_result"
103 },
104 {
105 "key": "_side_output_export_path",
106 "value": "bos://databuilder-workflow-dev/result/sideoutput/"
107 },
108 {
109 "key": "_side_output_data_path_type",
110 "value": "BOS_FILE_PATH"
111 },
112 {
113 "key": "_side_output_data_format",
114 "value": "CSV"
115 }
116 ],
117 "metaData": {
118 "catalogName": "system",
119 "schemaName": "default",
120 "operatorName": "adder",
121 "version": "v1",
122 "operatorIdentifier": "system_default_adder_v1"
123 },
124 "dependsOn": [
125 "opid-2"
126 ]
127 },
128 {
129 "name": "sink",
130 "id": "opid-4",
131 "params": [
132 {
133 "key": "export_path",
134 "value": "bos://databuilder-workflow-dev/result"
135 },
136 {
137 "key": "data_format",
138 "value": "CSV"
139 },
140 {
141 "key": "data_path_type",
142 "value": "BOS_FILE_PATH"
143 }
144 ],
145 "metaData": {
146 "catalogName": "system",
147 "schemaName": "default",
148 "operatorName": "exporter",
149 "version": "v1",
150 "operatorIdentifier": "system_default_exporter_v1"
151 },
152 "dependsOn": [
153 "opid-3"
154 ]
155 }
156 ]
157 },
158 "valid": true,
159 "taskProvided": false
160 },
161 {
162 "name": "W_RayTask_0",
163 "id": "tid-2",
164 "description": "desc",
165 "clusterList": [
166 {
167 "clusterId": "compute_9c2f_90d67c4011ed",
168 "engineType": "RAY",
169 "clusterType": "RESIDENT"
170 }
171 ],
172 "rayTask": {
173 "taskParam": {
174 "codePath": "/Workspace/Users/xiayu13/test.py-0.zip",
175 "runtimeEnv": [],
176 "entryPoint": "python test.py"
177 }
178 },
179 "dependsOn": [
180 "tid-1"
181 ],
182 "valid": true,
183 "taskProvided": false
184 },
185 {
186 "name": "W_DataFlowTask_1",
187 "id": "tid-3",
188 "description": "desc",
189 "clusterList": [
190 {
191 "clusterId": "compute_9c2f_90d67c4011ed",
192 "engineType": "RAY",
193 "clusterType": "RESIDENT"
194 }
195 ],
196 "compoundTask": {
197 "taskParam": {
198 "parallel": 1
199 },
200 "operators": [
201 {
202 "name": "source",
203 "id": "opid-1",
204 "params": [
205 {
206 "key": "data_path",
207 "value": "bos://databuilder-workflow-dev/data"
208 },
209 {
210 "key": "data_format",
211 "value": "CSV"
212 },
213 {
214 "key": "data_path_type",
215 "value": "BOS_FILE_PATH"
216 }
217 ],
218 "metaData": {
219 "catalogName": "system",
220 "schemaName": "default",
221 "operatorName": "databuilder_location_loader",
222 "version": "v1",
223 "operatorIdentifier": "system_default_databuilder_location_loader_v1"
224 }
225 },
226 {
227 "name": "Processor",
228 "id": "opid-2",
229 "params": [
230 {
231 "key": "process_index",
232 "value": "data_prefix"
233 },
234 {
235 "key": "output_index_left",
236 "value": "left"
237 },
238 {
239 "key": "output_index_right",
240 "value": "right"
241 },
242 {
243 "key": "num",
244 "value": "5"
245 }
246 ],
247 "metaData": {
248 "catalogName": "system",
249 "schemaName": "default",
250 "operatorName": "processor",
251 "version": "v1",
252 "operatorIdentifier": "system_default_processor_v1"
253 },
254 "dependsOn": [
255 "opid-1"
256 ]
257 },
258 {
259 "name": "Adder",
260 "id": "opid-3",
261 "params": [
262 {
263 "key": "add_left",
264 "value": "left"
265 },
266 {
267 "key": "add_right",
268 "value": "right"
269 },
270 {
271 "key": "index_name",
272 "value": "add_result"
273 },
274 {
275 "key": "_side_output_export_path",
276 "value": "bos://databuilder-workflow-dev/result/sideoutput/"
277 },
278 {
279 "key": "_side_output_data_path_type",
280 "value": "BOS_FILE_PATH"
281 },
282 {
283 "key": "_side_output_data_format",
284 "value": "CSV"
285 }
286 ],
287 "metaData": {
288 "catalogName": "system",
289 "schemaName": "default",
290 "operatorName": "adder",
291 "version": "v1",
292 "operatorIdentifier": "system_default_adder_v1"
293 },
294 "dependsOn": [
295 "opid-2"
296 ]
297 },
298 {
299 "name": "sink",
300 "id": "opid-4",
301 "params": [
302 {
303 "key": "export_path",
304 "value": "bos://databuilder-workflow-dev/result"
305 },
306 {
307 "key": "data_format",
308 "value": "CSV"
309 },
310 {
311 "key": "data_path_type",
312 "value": "BOS_FILE_PATH"
313 }
314 ],
315 "metaData": {
316 "catalogName": "system",
317 "schemaName": "default",
318 "operatorName": "exporter",
319 "version": "v1",
320 "operatorIdentifier": "system_default_exporter_v1"
321 },
322 "dependsOn": [
323 "opid-3"
324 ]
325 }
326 ]
327 },
328 "dependsOn": [
329 "tid-2"
330 ],
331 "valid": true,
332 "taskProvided": false
333 },
334 {
335 "name": "W_RayTask_1",
336 "id": "tid-4",
337 "description": "desc",
338 "clusterList": [
339 {
340 "clusterId": "compute_9c2f_90d67c4011ed",
341 "engineType": "RAY",
342 "clusterType": "RESIDENT"
343 }
344 ],
345 "rayTask": {
346 "taskParam": {
347 "codePath": "/Workspace/Users/xiayu13/test.py-0.zip",
348 "runtimeEnv": [],
349 "entryPoint": "python test.py"
350 }
351 },
352 "dependsOn": [
353 "tid-3"
354 ],
355 "valid": true,
356 "taskProvided": false
357 }
358 ]
359 }
360}