创建工作流定义。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| emr-serverless-spark:CreateProcessDefinitionWithSchedule | none | *全部资源 * |
| 无 |
请求语法
POST /dolphinscheduler/projects/{bizId}/process-definition HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| productNamespace | string | 是 | 产品编码。 | SS |
| bizId | string | 是 | 工作空间 ID。 | w-d8******** |
| name | string | 是 | 工作流名称。 | ods_batch_workflow |
| description | string | 是 | 工作流描述。 | ods batch workflow |
| timeout | integer | 否 | 工作流运行默认 timeout。 | 60 |
| taskRelationJson | array<object> | 是 | 任务依赖关系 JSON 数组，包含工作流所有任务之间的依赖关系，preTaskCode 为上游任务 ID，postTaskCode 为下游任务 ID，每一个任务需有唯一的 ID。如果任务节点没有上游任务，也需要增加一个 preTaskCode 为 0 的依赖关系。 | |
| object | 是 | 任务依赖关系 JSON，包含工作流所有任务之间的依赖关系，preTaskCode 为上游任务 ID，postTaskCode 为下游任务，每一个任务需有唯一的 ID。如果任务节点没有上游任务，也需要增加一个 preTaskCode 为 0 的依赖关系。 | ||
| name | string | 是 | 任务拓扑关系名称，填工作流名称即可。 | ods batch workflow |
| preTaskCode | long | 是 | 上游任务 ID。 | 16************ |
| preTaskVersion | integer | 是 | 上游任务版本。 | 1 |
| postTaskCode | long | 是 | 下游任务 ID。 | 28************ |
| postTaskVersion | integer | 是 | 下游任务版本。 | 1 |
| taskDefinitionJson | array<object> | 是 | 任务定义 JSON 数组，包含工作流所有任务的描述信息。 | |
| object | 是 | 任务定义 JSON，包含工作流所有任务的描述信息。 | ||
| code | long | 是 | 任务定义 ID。 | 36************ |
| description | string | 否 | 任务定义描述。 | ods transform task |
| alertEmailAddress | string | 否 | 告警邮箱地址。 | foo_bar@spark.alert.invalid.com |
| startAlertEnable | boolean | 否 | 任务启动告警开启。 | false |
| failAlertEnable | boolean | 否 | 任务失败告警开启。 | false |
| failRetryTimes | integer | 否 | 任务失败重试次数。 | 1 |
| name | string | 是 | 任务名称。 | ods_transform_task |
| taskParams | object | 是 | 任务定义参数。 | |
| workspaceBizId | string | 是 | 工作空间 ID。 | w-d8******** |
| taskBizId | string | 是 | 数据开发任务 ID。 | TSK-d87****************** |
| resourceQueueId | string | 是 | Spark 任务运行的资源队列。 | root_queue |
| sparkDriverCores | integer | 否 | Spark 任务 Driver 核数。 | 1 |
| sparkExecutorCores | integer | 否 | Spark 任务 Executor 核数。 | 1 |
| sparkDriverMemory | long | 否 | Spark 任务 Driver 内存。 | 4g |
| sparkExecutorMemory | long | 否 | Spark 任务 Executor 内存。 | 4g |
| sparkConf | array<object> | 否 | Spark 任务配置。 | |
| object | 否 | |||
| 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。 | env-crhq2h5lhtgju93buhkg |
| type | string | 否 | Spark 任务类型。 | SQL |
| taskType | string | 是 | 工作流节点类型。 | EMR_SERVERLESS_SPARK |
| timeout | integer | 否 | 回调方法的超时时间，单位为秒。 | 1200 |
| tags | object | 否 | 标签。 | |
| string | 否 | 标签对 JSON 字符串。 | ||
| 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 |
| resourceQueue | string | 否 | 资源队列。 | root_queue |
| tags | object | 否 | 标签。 | |
| string | 否 | 标签对 JSON 字符串。 | “{\"tagkey\":\"tagvalue\"}” | |
| publish | boolean | 否 | 是否发布工作流。 | true |
| regionId | string | 否 | 区域 ID。 | cn-hangzhou |
| runAs | string | 否 | 执行用户阿里云 UID。 | 113*************** |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
"code": 1400009,
"msg": "No permission for resource action",
"success": true,
"failed": false,
"data": {
"id": 12342,
"code": 0
},
"httpStatusCode": 200
}错误码
访问错误中心查看更多错误码。