启动工作流定时调度
更新时间：2025-08-06
接口描述
为增加了定时调度的工作流启动定时调度任务
权限说明
用户为工作空间下特定工作流WORKFLOW启动定时调度任务，需具有以下任一权限
- 运行工作流的权限: 运行
EXECUTE - 编辑工作流的权限：编辑
MODIFY - 管理工作流的权限：管理
MANAGE
注意事项
- 用户没有权限，则启动定时调度失败
- 工作流或者工作空间不存在，则启动定时调度失败。
- 工作流已经开启定时调度，无法再次发起启动定时调度请求
- 工作流没有定时调度配置，则无法启动定时调度配置
- 定时调度配置中的开始时间晚于结束时间，则无法启动定时调度配置
- crontab表达式格式错误，则无法启动定时调度任务
- 用户工作流配置错误，则无法启动定时调度任务
请求结构
Plain Text
1PATCH /v2/workspaces/{workspaceId}/job/{jobId}/schedule?enable HTTP/1.1
2Host: databuilder.bd.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域
请求参数
| 参数名 | 类型 | 是否必填 | 参数位置 | 说明 |
|---|---|---|---|---|
| workspaceId | String | 是 | Path参数 | 工作空间ID，不允许为空或者只包含空白字符 |
| jobId | String | 是 | Path参数 | 工作流ID，不允许为空或者只包含空白字符 |
| enable | String | 是 | Query参数 | 无需提供参数值 |
响应头域
除公共头域外，无其它特殊头域
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 请求ID |
| code | String | 响应码 |
| message | String | 响应描述信息 |
| result | string | 请求结果描述文本 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| AccessDenied | 无操作权限 | 403 | 暂无操作权限 |
| NotExists | 运行记录不存在 | 404 | 运行记录不存在 |
| IllegalArgument | 参数错误 | 400 | 用户提供了非法的请求参数，或者运行记录当前状态不允许停止 |
请求示例
Plain Text
1PATCH https://databuilder.bd.baidubce.com/v2/workspaces/workspace_9862_0763f283d58a/job/jid_8de75d63f92d3e53/schedule?enable
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{
9 "requestId": "req-123456",
10 "code": "200",
11 "message": "成功",
12 "result": "启动工作流[job-789]定时调度成功"
13}