更新工作流定义和定时调度。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
emr-serverless-spark:UpdateProcessDefinitionWithSchedule |
none |
*全部资源
|
无 | 无 |
请求语法
PUT /dolphinscheduler/projects/{bizId}/process-definition/{code} HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| bizId |
string |
是 |
工作空间 ID。 |
w-d8******** |
| code |
integer |
是 |
任务定义 ID。 |
12************ |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| productNamespace |
string |
是 |
产品编码。 |
SS |
| name |
string |
是 |
工作流名称。 |
ods_batch_workflow |
| description |
string |
否 |
工作流描述。 |
ods batch workflow |
| timeout |
integer |
否 |
工作流运行默认 timeout。 |
300 |
| taskDefinitionJson |
array<object> |
是 |
任务定义 JSON 数组，包含工作流所有任务的描述信息。 |
|
|
array<object> |
是 |
任务定义 JSON，包含工作流所有任务的描述信息。 |
||
| code |
integer |
是 |
任务定义 ID。 |
23************ |
| description |
string |
否 |
任务定义描述。 |
ods transform task |
| alertEmailAddress |
string |
否 |
告警邮箱地址。 |
foo_bar@spark.alert.invalid.com |
| startAlertEnable |
boolean |
否 |
任务启动告警开启。 |
true |
| failAlertEnable |
boolean |
否 |
任务失败告警开启。 |
true |
| failRetryTimes |
integer |
否 |
任务失败重试次数。 |
1 |
| name |
string |
是 |
任务名称。 |
ods_transform_task |
| taskParams |
object |
是 |
任务定义参数。 |
|
| workspaceBizId |
string |
是 |
工作空间 ID。 |
w-d8******** |
| taskBizId |
string |
是 |
数据开发任务 ID。 |
TSK-d87****************** |
| resourceQueueId |
string |
是 |
运行任务的队列名称。 |
root_queue |
| sparkDriverCores |
integer |
否 |
Spark 任务 Driver 核数。 |
1 |
| sparkExecutorCores |
integer |
否 |
Spark 任务 Executor 核数。 |
1 |
| sparkDriverMemory |
integer |
否 |
Spark 任务 Driver 内存。 |
4g |
| sparkExecutorMemory |
integer |
否 |
Spark 任务 Executor 内存。 |
4g |
| sparkConf |
array<object> |
否 |
Spark 任务配置。 |
|
|
object |
否 |
Spark 任务配置。 |
||
| key |
string |
否 |
Spark Conf 配置 key。 |
spark.dynamicAllocation.enabled |
| value |
string |
否 |
Spark Conf 配置 value。 |
true |
| sparkVersion |
string |
否 |
Spark 引擎版本。 |
esr-4.0.0 (Spark 3.5.2, Scala 2.12) |
| sparkLogLevel |
string |
否 |
Spark 日志级别。 |
INFO |
| sparkLogPath |
string |
否 |
Spark 任务日志路径。 |
oss://data***/spark/logs |
| displaySparkVersion |
string |
否 |
Spark 引擎显示版本。 |
esr-4.0.0 (Spark 3.5.2, Scala 2.12) |
| fusion |
boolean |
否 |
是否开启 Fusion 引擎加速。 |
false |
| environmentId |
string |
否 |
环境 id。 |
ev-h************* |
| type |
string |
否 |
Spark 作业类型。 |
SQL |
| localParams |
array<object> |
否 |
||
|
object |
否 |
|||
| prop |
string |
否 |
||
| direct |
string |
否 |
||
| type |
string |
否 |
||
| value |
string |
否 |
||
| taskType |
string |
是 |
工作流节点类型。 |
EMR-SERVERLESS-SPARK |
| timeout |
integer |
否 |
任务运行默认 timeout。 |
30 |
| tags |
object |
否 |
标签。 |
|
|
string |
否 |
标签对 JSON 字符串。 |
“{\"tagkey\":\"tagvalue\"}” |
|
| taskRelationJson |
array<object> |
是 |
任务依赖关系 JSON 数组，包含工作流所有任务之间的依赖关系，preTaskCode 为上游任务 ID，postTaskCode 为下游任务 ID，每一个任务需有唯一的 ID。如果任务节点没有上游任务，也需要增加一个 preTaskCode 为 0 的依赖关系。 |
|
|
object |
是 |
任务依赖关系 JSON，包含工作流所有任务之间的依赖关系，preTaskCode 为上游任务 ID，postTaskCode 为下游任务 ID，每一个任务需有唯一的 ID。如果任务节点没有上游任务，也需要增加一个 preTaskCode 为 0 的依赖关系。 |
||
| name |
string |
是 |
任务拓扑关系名称，填工作流名称即可。 |
ods batch workflow |
| preTaskCode |
integer |
是 |
上游任务 ID。 |
16************ |
| preTaskVersion |
integer |
是 |
上游任务版本。 |
1 |
| postTaskCode |
integer |
是 |
下游任务 ID。 |
19************ |
| postTaskVersion |
integer |
是 |
下游任务版本。 |
1 |
| executionType |
string |
是 |
执行策略 |
PARALLEL |
| alertEmailAddress |
string |
否 |
告警邮箱地址。 |
foo_bar@spark.alert.invalid.com |
| schedule |
object |
否 |
调度结构 |
|
| startTime |
string |
否 |
开始时间。 |
2024-12-23 16:13:27 |
| endTime |
string |
否 |
调度结束时间。 |
2025-12-23 16:13:27 |
| crontab |
string |
否 |
调度 cron 表达式。 |
0 0 0 * * ? |
| timezoneId |
string |
否 |
时区 ID。 |
Asia/Shanghai |
| retryTimes |
integer |
否 |
重试次数。 |
1 |
| taskParallelism |
integer |
否 |
工作流节点运行并发度。 |
1 |
| tags |
object |
否 |
标签。 |
|
|
string |
否 |
标签对 JSON 字符串。 |
“{\"tagkey\":\"tagvalue\"}” |
|
| resourceQueue |
string |
否 |
资源队列。 |
root_queue |
| releaseState |
string |
否 |
工作流上线状态。 |
ONLINE |
| runAs |
string |
否 |
执行用户。 |
113*************** |
| publish |
boolean |
否 |
是否发布工作流。 |
true |
| regionId |
string |
否 |
区域 ID。 |
cn-hangzhou |
| globalParams |
array<object> |
否 |
||
|
object |
否 |
|||
| prop |
string |
否 |
||
| value |
string |
否 |
||
| direct |
string |
否 |
||
| type |
string |
否 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
Id of the request |
DD6B1B2A-5837-5237-ABE4-FF0C8944**** |
| code |
integer |
API 后端返回码。 |
1400009 |
| msg |
string |
请求 code 对应的详细描述信息。 |
No permission for resource action |
| success |
string |
请求是否成功。 |
true |
| failed |
string |
失败个数。 |
false |
| data |
object |
返回数据。 |
|
| id |
string |
工作流定义编号。 |
123223 |
| code |
string |
工作流定义 ID。 |
12*********** |
| name |
string |
工作流定义名称。 |
ods_batch_workflow |
| version |
integer |
版本号。 |
1 |
| releaseState |
string |
工作流上线状态 |
ONLINE |
| bizId |
string |
工作空间 ID。 |
alicloud_ack_one_cluster |
| description |
string |
任务定义描述。 |
1 |
| createTime |
string |
工作流定义创建时间。 |
2024-09-05T02:03:19Z |
| updateTime |
string |
工作流定义更新时间。 |
2024-03-05T06:24:27Z |
| userId |
string |
调度用户 ID。 |
113********* |
| userName |
string |
调度用户名称。 |
w-******** |
| projectName |
string |
工作流对应项目名称。 |
w-******** |
| executionType |
string |
执行策略。 |
SERIAL |
| alertEmailAddress |
string |
告警邮件地址。 |
foo_bar@spark.alert.invalid.com |
| startTime |
string |
调度开始时间。 |
0 |
| endTime |
string |
任务结束时间范围的终点。 |
1710432000000 |
| timezoneId |
string |
时区 ID。 |
Asia/Shanghai |
| crontab |
string |
调度 cron 表达式。 |
0 0 0 * * ? |
| versionHashCode |
string |
版本哈希编码。 |
dwerf********* |
| httpStatusCode |
integer |
HTTP 状态编码 |
200 |
示例
正常返回示例
JSON格式
{
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
"code": 1400009,
"msg": "No permission for resource action",
"success": "true",
"failed": "false",
"data": {
"id": "123223",
"code": "12***********",
"name": "ods_batch_workflow",
"version": 1,
"releaseState": "ONLINE",
"bizId": "alicloud_ack_one_cluster",
"description": "1",
"createTime": "2024-09-05T02:03:19Z",
"updateTime": "2024-03-05T06:24:27Z",
"userId": "113*********",
"userName": "w-********",
"projectName": "w-********",
"executionType": "SERIAL",
"alertEmailAddress": "foo_bar@spark.alert.invalid.com\n",
"startTime": "0",
"endTime": "1710432000000",
"timezoneId": "Asia/Shanghai\n",
"crontab": "0 0 0 * * ?\n",
"versionHashCode": "dwerf*********"
},
"httpStatusCode": 200
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。