运行工作流
更新时间:2025-08-06
接口描述
运行指定的工作流
权限说明
用户运行工作空间下特定工作流WORKFLOW
,需具有以下任一权限
- 运行工作流的权限: 运行
EXECUTE
- 编辑工作流的权限:编辑
MODIFY
- 管理工作流的权限:管理
MANAGE
额外的,对于工作流中用到的工作区文件,常驻实例,任务实例模板,算子等资源,用户也需要有相应的权限:
- 对于使用到的工作区文件
FILE
,需要用户具有以下任一权限
a. 运行文件的权限: 运行EXECUTE
b. 修改文件的权限: 编辑MODIFY
c. 管理文件的权限: 管理MANAGE
- 对于常驻实例
ETL_COMPUTE
,需要拥有以下任一权限
a. 使用常驻实例的权限: 使用USE
b. 管理常驻实例的权限: 管理MANAGE
- 对于任务实例模板
ETL_JOB_TEMPLATE
,需要拥有以下任一权限
a. 使用任务实例模板的权限: 使用USE
b. 管理任务实例模板的权限: 管理MANAGE
- 对应工作流中使用分析与AI搜索实例
ANALYSIS_COMPUTE
,需要拥有以下任一权限:
a. 使用分析与AI搜索实例的权限: 使用USE
b. 管理分析与AI搜索实例的权限: 管理MANAGE
- 对于使用到的非系统内置算子
OPERATOR
,需要拥有以下任一权限:
a. 执行算子的权限: 执行EXECUTE
b. 新增算子版本的权限: 新建版本CREATE_OPERATOR_VERSION
- 对于使用到的卷
VOLUME
需要有以下权限:
a. 当通过算子写入卷时,需要对卷有写入WRITE_VOLUME
权限
b. 当通过算子读取卷时,需要对卷有读取READ_VOLUME
权限
注意事项
- 工作空间不存在,则运行工作流失败
- 工作流不存在,则运行工作流失败
- 用户权限不足,则运行工作流失败
- 用户工作流中的任务,算子信息不合法,则运行工作流失败
请求结构
Plain Text
1PUT /v2/workspaces/{workspaceId}/job/{jobId}?start HTTP/1.1
2Host: databuilder.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域
请求参数
参数名 | 类型 | 是否必填 | 参数位置 | 说明 |
---|---|---|---|---|
workspaceId | String | 是 | Path参数 | 工作空间ID,不允许为空或者只包含空白字符 |
jobId | String | 是 | Path参数 | 工作流ID,不允许为空或者只包含空白字符 |
start | String | 是 | Query参数 | 无需填入值,仅提供参数名即可 |
响应头域
除公共头域外,无其它特殊头域
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
requestId | String | 请求ID |
code | String | 响应码 |
message | String | 响应描述信息 |
result | string | 运行记录ID |
错误码
错误码 | 错误描述 | HTTP状态码 | 中文解释 |
---|---|---|---|
AccessDenied | 无操作权限 | 403 | 暂无操作权限 |
IllegalArgument | 参数非法 | 400 | 参数错误 |
请求示例
Plain Text
1PUT https://databuilder.bd.baidubce.com/v2/workspaces/workspace_9862_0763f283d58a/job/jid_8de75d63f92d3e53?start
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": "caa1f287-e4d4-454d-b2ca-425a51735039",
9 "code": "SUCCESS",
10 "result": "ins_b5bd43f7a98782a0"
11}