UpdateWorkflow
更新工作流
服务地址：
华东1（杭州）
输入参数
只看必填
projectId项目ID
workflowId工作流ID
workspaceId工作空间ID
name工作流名称
taskRelationJson任务依赖关系json
taskDefinitionJson任务定义json
description描述
workflowParams工作流参数
parentDirectoryId目录ID
timeout超时的时间
executionType执行策略
scheduleState调度状态
scheduleStartTime调度起始时间
scheduleEndTime调度结束时间
cronExpr调度cron表达式
timeZone时区
failureStrategy失败策略
alertStrategy通知策略
alertGroupId告警组ID
workflowInstancePriority工作流实例优先级
resourceGroupId资源组ID
body
taskRelationJsonValue
taskDefinitionJsonValue
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

请求语法

PUT /dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId} HTTP/1.1

路径参数

字段名称字段详情
projectIdstring

项目 ID

示例值:p-3q9jo749ne5****参考取值来源:
    ListProjects
workflowIdstring

工作流 ID

示例值:w-n72kong0832****参考取值来源:
    ListWorkflows
    CreateWorkflow
    DescribeWorkflowInstance

请求参数

字段名称字段详情
workspaceIdstring

工作空间 ID

示例值:123***
namestring

工作流名称

示例值:test
taskRelationJsonstring

任务依赖关系 json，包含工作流所有任务之间的依赖关系，preTaskId 为上游任务 id，postTaskId 为下游任务 id，此处指定的任务 id 为自定义 id（不能为 0），每一个任务需有唯一的 id。如果任务节点没有上游任务，也需要增加一个 preTaskId 为 0 的依赖关系

示例值: [{"preTaskId":"0", "postTaskId":"t1"}]
taskDefinitionJsonstring

任务定义 json，包含工作流所有任务的描述信息

示例值: [{"taskId":"t1","name":"t1","taskParams":{"rawScript":"echo 1"},"taskType":"SHELL"}]
descriptionstring

描述

示例值:test
workflowParamsstring

工作流参数

示例值:[{"prop":"key1","value":"value1"}]参考取值来源:
    DescribeWorkflow
parentDirectoryIdstring

目录 ID

示例值:wd-n72kong0832****
timeoutinteger<int32>

超时的时间，单位：分钟

示例值:10
executionTypestring

执行策略

示例值:PARALLEL枚举值:SERIAL_WAITPARALLEL
scheduleStatestring

调度状态

示例值:OFFLINE枚举值:OFFLINEONLINE
scheduleStartTimestring

调度起始时间

示例值:2024-01-01 00:00:00
scheduleEndTimestring

调度结束时间

示例值:2024-01-01 00:00:00
cronExprstring

调度 cron 表达式

示例值:0 0 * * * ? *
timeZonestring

时区

示例值:Asia/Shanghai
failureStrategystring

失败策略

示例值:END枚举值:CONTINUEEND
alertStrategystring

通知策略

示例值:NONE枚举值:ALLSUCCESSNONEFAILURE
alertGroupIdstring

告警组 ID

示例值:ag-n72kong0832****参考取值来源:
    ListAlertGroups
workflowInstancePrioritystring

工作流实例优先级

示例值:MEDIUM枚举值:LOWESTHIGHMEDIUMLOWHIGHEST参考取值来源:
    DescribeWorkflowInstance
resourceGroupIdstring

资源组 ID

示例值:wg-acfmv4opbs****参考取值来源:
    ListResourceGroups
bodyobject

返回参数

字段名称字段详情
requestIdstring

Id of the request

示例值:DD6B1B2A-5837-5237-ABE4-FF0C8944****
successboolean

调用是否成功

示例值:true
变更历史
变更时间变更内容概要操作
2024-09-06
变更请求参数body
2024-09-05
新增请求参数body