CreateProcessDefinitionWithSchedule - 创建工作流定义和调度

创建工作流定义。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
emr-serverless-spark:CreateProcessDefinitionWithSchedulenone
*全部资源
*

请求语法

POST /dolphinscheduler/projects/{bizId}/process-definition HTTP/1.1

请求参数

名称类型必填描述示例值
productNamespacestring

产品编码。

SS
bizIdstring

工作空间 ID。

w-d8********
namestring

工作流名称。

ods_batch_workflow
descriptionstring

工作流描述。

ods batch workflow
timeoutinteger

工作流运行默认 timeout。

60
taskRelationJsonarray<object>

任务依赖关系 JSON 数组,包含工作流所有任务之间的依赖关系,preTaskCode 为上游任务 ID,postTaskCode 为下游任务 ID,每一个任务需有唯一的 ID。如果任务节点没有上游任务,也需要增加一个 preTaskCode 为 0 的依赖关系。

object

任务依赖关系 JSON,包含工作流所有任务之间的依赖关系,preTaskCode 为上游任务 ID,postTaskCode 为下游任务,每一个任务需有唯一的 ID。如果任务节点没有上游任务,也需要增加一个 preTaskCode 为 0 的依赖关系。

namestring

任务拓扑关系名称,填工作流名称即可。

ods batch workflow
preTaskCodelong

上游任务 ID。

16************
preTaskVersioninteger

上游任务版本。

1
postTaskCodelong

下游任务 ID。

28************
postTaskVersioninteger

下游任务版本。

1
taskDefinitionJsonarray<object>

任务定义 JSON 数组,包含工作流所有任务的描述信息。

object

任务定义 JSON,包含工作流所有任务的描述信息。

codelong

任务定义 ID。

36************
descriptionstring

任务定义描述。

ods transform task
alertEmailAddressstring

告警邮箱地址。

foo_bar@spark.alert.invalid.com
startAlertEnableboolean

任务启动告警开启。

false
failAlertEnableboolean

任务失败告警开启。

false
failRetryTimesinteger

任务失败重试次数。

1
namestring

任务名称。

ods_transform_task
taskParamsobject

任务定义参数。

workspaceBizIdstring

工作空间 ID。

w-d8********
taskBizIdstring

数据开发任务 ID。

TSK-d87******************
resourceQueueIdstring

Spark 任务运行的资源队列。

root_queue
sparkDriverCoresinteger

Spark 任务 Driver 核数。

1
sparkExecutorCoresinteger

Spark 任务 Executor 核数。

1
sparkDriverMemorylong

Spark 任务 Driver 内存。

4g
sparkExecutorMemorylong

Spark 任务 Executor 内存。

4g
sparkConfarray<object>

Spark 任务配置。

object
keystring

Spark Conf 配置 key。

spark.dynamicAllocation.enabled
valuestring

Spark Conf 配置 value。

true
sparkVersionstring

Spark 引擎版本。

esr-4.0.0 (Spark 3.5.2, Scala 2.12)
sparkLogLevelstring

Spark 日志级别。

INFO
sparkLogPathstring

Spark 任务日志路径。

oss://data***/spark/logs
displaySparkVersionstring

Spark 引擎显示版本。

esr-4.0.0 (Spark 3.5.2, Scala 2.12)
fusionboolean

是否开启 Fusion 引擎加速。

false
environmentIdstring

环境 id。

env-crhq2h5lhtgju93buhkg
typestring

Spark 任务类型。

SQL
taskTypestring

工作流节点类型。

EMR_SERVERLESS_SPARK
timeoutinteger

回调方法的超时时间,单位为秒。

1200
tagsobject

标签。

string

标签对 JSON 字符串。

“{\"tagkey\":\"tagvalue\"}”
executionTypestring

执行策略

PARALLEL
alertEmailAddressstring

告警邮箱地址。

foo_bar@spark.alert.invalid.com
scheduleobject

调度结构

startTimestring

调度开始时间。

2024-12-23 16:13:27
endTimestring

调度结束时间。

2025-12-23 16:13:27
crontabstring

调度 cron 表达式。

0 0 0 * * ?
timezoneIdstring

时区 ID。

Asia/Shanghai
retryTimesinteger

重试次数。

1
taskParallelisminteger

任务并发度。

1
resourceQueuestring

资源队列。

root_queue
tagsobject

标签。

string

标签对 JSON 字符串。

“{\"tagkey\":\"tagvalue\"}”
publishboolean

是否发布工作流。

true
regionIdstring

区域 ID。

cn-hangzhou
runAsstring

执行用户阿里云 UID。

113***************

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID。

DD6B1B2A-5837-5237-ABE4-FF0C8944****
codeinteger

API 返回编码。

1400009
msgstring

请求 code 对应的详细描述信息。

No permission for resource action
successstring

请求是否成功。

true
failedstring

请求是否失败。

false
dataobject

返回结果。

idinteger

工作流定义编号。

12342
codelong

工作流定义 ID。

160************
httpStatusCodeinteger

HTTP 状态编码。

200

示例

正常返回示例

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
}

错误码

访问错误中心查看更多错误码。