增加定时调度配置
更新时间：2025-08-06
接口描述
给工作流增加定时调度配置，如果已有定时调度配置，则会进行覆盖。
权限说明
用户为工作空间下特定工作流WORKFLOW增加定时调度配置，需具有以下任一权限
- 运行工作流的权限: 运行
EXECUTE - 编辑工作流的权限：编辑
MODIFY - 管理工作流的权限：管理
MANAGE
注意事项
- 用户没有权限，则添加定时调度配置失败
- 工作流或者工作空间不存在，则添加定时调度配置失败。
- 工作流已经开启定时调度，则无法添加定时调度配置
请求结构
Plain Text
1POST /v2/workspaces/{workspaceId}/job/{jobId}/schedule?create HTTP/1.1
2Host: databuilder.bd.baidubce.com
3Authorization: authorization string
4{
5 "startTime": "2025-07-23 00:00:00",
6 "endTime": "2125-07-23 23:59:59",
7 "crontab": "0 3 * * * ?"
8}请求头域
除公共头域外，无其它特殊头域
请求参数
| 参数名 | 类型 | 是否必填 | 参数位置 | 说明 |
|---|---|---|---|---|
| workspaceId | String | 是 | Path参数 | 工作空间ID，不允许为空或者只包含空白字符 |
| jobId | String | 是 | Path参数 | 工作流ID，不允许为空或者只包含空白字符 |
| create | String | 是 | Query参数 | 无需提供参数值 |
| crontab | String | 是 | Body参数 | Crontab 表达式，必须是可触发的表达式，且触发周期需 ≥ 60 秒。 示例：不能使用 2.31 * * * *（因每月 31 号并不总存在）。 |
| endTime | String | 是 | Body参数 | 停止时间，格式为 yyyy-MM-dd HH:mm:ss，例如：2025-04-20 10:59:59。 |
| startTime | String | 是 | Body参数 | 开始时间，格式为 yyyy-MM-dd HH:mm:ss，例如：2025-04-20 10:00:00。 |
响应头域
除公共头域外，无其它特殊头域
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 请求ID |
| code | String | 响应码 |
| message | String | 响应描述信息 |
| result | string | 请求结果描述文本 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| AccessDenied | 无操作权限 | 403 | 暂无操作权限 |
| NotExists | 运行记录不存在 | 404 | 运行记录不存在 |
| IllegalArgument | 参数错误 | 400 | 1. crontab表达式错误 2. startTime && endTime格式错误 |
请求示例
Plain Text
1POST https://databuilder.bd.baidubce.com/v2/workspaces/workspace_9862_0763f283d58a/job/jid_8de75d63f92d3e53/schedule?create
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
11{
12 "startTime": "2025-07-23 00:00:00",
13 "endTime": "2025-07-23 23:59:59",
14 "crontab": "0 5 * * * ?"
15}响应示例
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": "6efc6029-9983-4276-b723-b3ae5199ca37",
9 "code": "SUCCESS",
10 "result": "为工作流[jid_8de75d63f92d3e53]增加定时调度配置成功"
11}