修改工作流
更新时间：2025-08-07
接口描述
修改工作空间下指定工作流名称，任务配置以及定时调度配置
权限说明
用户修改工作空间下特定工作流WORKFLOW，需具有以下任一权限
- 编辑工作流的权限：编辑
MODIFY - 管理工作流的权限：管理
MANAGE
额外的，如果需要修改工作流名称，则需要管理MANAGE权限
注意事项
- 工作空间不存在，修改工作流详情会失败
- 工作流不存在，则修改工作流详情会失败。
- 用户权限不足，则修改工作流详情失败
- 如果已经开启了定时调度任务，则修改定时调度配置会被拒绝。
请求结构
Plain Text
1PUT https://databuilder.bd.baidubce.com/v2/workspaces/{workspaceId}/job/{jobId} HTTP/1.1
2Host: databuilder.bd.baidubce.com
3Authorization: authorization string
4{
5 "name": "name",
6 "description": "desc",
7 "tasks": [
8 {
9 "name": "name",
10 "id": "id",
11 "description": "desc",
12 "clusterList": [
13 {
14 "clusterId": "clusterId",
15 "engineType": "type",
16 "clusterType": "type"
17 }
18 ],
19 "rayTask": {
20 "taskParam": {
21 "codePath": "path",
22 "runtimeEnv": [
23 {
24 "key": "KEY",
25 "value": "VALUE"
26 }
27 ],
28 "entryPoint": "entryPoint"
29 }
30 },
31 "taskStatus": "status",
32 "durationSec": 0,
33 "startTime": "startTime",
34 "endTime": "endTime"
35 }
36 ],
37 "scheduleConf": {
38 "startTime": "startTime",
39 "endTime": "endTime",
40 "crontab": "crontab"
41 }
42}请求头域
除公共头域外，无其它特殊头域
请求参数
| 字段名 | 类型 | 是否必填 | 参数位置 | 说明 |
|---|---|---|---|---|
| workspaceId | String | 是 | Path参数 | 工作空间ID, 不能只传入空白字符 |
| jobId | String | 是 | Path参数 | 工作流ID, 不能只传入空白字符 |
| modifyAttribute | String | 是 | Query参数 | 无需参数值，仅提供参数名即可 |
| name | String | 是 | Body参数 | 作业名称 |
| description | String | 是 | Body参数 | 作业描述 |
| tasks | Task[] | 是 | Body参数 | 作业包含的任务列表 |
| scheduleConf | ScheduleConf | 否 | Body参数 | 定时调度配置 |
ScheduleConf
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| startTime | String | 是 | 开始时间，格式为 yyyy-MM-dd HH:mm:ss，必须是有效日期时间 |
| endTime | String | 是 | 结束时间，格式为 yyyy-MM-dd HH:mm:ss，必须是有效日期时间 |
| crontab | String | 是 | Crontab 表达式，必须是可触发的，且周期必须大于等于 60 秒 |
响应头域
除公共头域外，无其它特殊头域
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 请求ID |
| code | String | 响应码 |
| message | String | 响应描述信息 |
| result | String | 请求结果描述信息 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| AccessDenied | 无操作权限 | 403 | 暂无操作权限 |
| IllegalArgument | 参数非法 | 400 |
请求示例
Plain Text
1PUT https://databuilder.bd.baidubce.com/v2/workspaces/workspace_9862_0763f283d58a/job/jid_8de75d63f92d3e53?modifyAttribute
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 "name": "name_6c9b7bcfa800",
13 "description": "description_2b411556a702",
14 "tasks": [
15 {
16 "name": "name_32429c2ce9d2",
17 "id": "id_fddb6cae0c77",
18 "description": "description_a74cf0c93027",
19 "clusterList": [
20 {
21 "clusterId": "compute_xxxxxx",
22 "engineType": "RAY",
23 "clusterType": "RESIDENT"
24 }
25 ],
26 "rayTask": {
27 "taskParam": {
28 "codePath": "dir/file/test.py",
29 "runtimeEnv": [
30 {
31 "key": "KEY",
32 "value": "value"
33 }
34 ],
35 "entryPoint": "python test.py"
36 }
37 },
38 "taskStatus": "RUNNING_EXECUTION",
39 "durationSec": 0,
40 "startTime": "2025-05-05 05:05:05",
41 "endTime": "2025-05-05 05:05:06"
42 }
43 ],
44 "scheduleConf": {
45 "startTime": "2025-05-05 05:05:05",
46 "endTime": "2025-05-06 05:05:06",
47 "crontab": "0 0 0 0 1"
48 }
49}响应示例
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}