UpdateWorkflowDefinition - 更新数据开发工作流信息

更新时间:2025-02-19 03:24:41

调用此接口,可以更新数据开发工作流基本信息。更新以增量更新的方式进行,更新信息以FlowSpec格式描述。

接口说明

注意
该接口不支持批量操作,若 FlowSpec 中定义了不止一个工作流,则除第一个以外的后续工作流均会被忽略。此外,工作流内部定义的节点也会被直接忽略,请调用 UpdateNode 接口依次更新内部节点。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

DataWorks 工作空间的 ID,您可以登录 DataWorks 控制台,进入工作空间管理页面查看 ID。

10001
Idlong

数据开发工作流唯一标识符。

652567824470354XXXX
Specstring

描述这个数据开发工作流的 FlowSpec 信息,具体规范详见 FlowSpec

{ "kind": "CycleWorkflow", "version": "1.1.0", "spec": { "name": "OpenAPI Test Workflow Demo", "type": "CycleWorkflow", "id": "652567824470354XXXX", "workflows": [ { "id": "652567824470354XXXX", "script": { "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo", "runtime": { "command": "WORKFLOW" } }, "trigger": { "type": "Scheduler", "cron": "00 02 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "strategy": { "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "failureStrategy": "Break" }, "name": "OpenAPI Test Workflow Demo", "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "workflow_output", "artifactType": "NodeOutput", "refTableName": "OpenAPI_Test_Workflow_Demo" } ] }, "nodes": [], "dependencies": [] } ] } }

返回参数

名称类型描述示例值
名称类型描述示例值
object

Schema of Response

RequestIdstring

请求的 ID。用于定位日志,排查问题。

20BF7E80-668A-5620-8AD8-879B8FEA****
Successboolean

是否调用成功,取值如下:

  • true:调用成功。
  • false:调用失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "20BF7E80-668A-5620-8AD8-879B8FEA****",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2025-01-13API 内部配置变更,不影响调用查看变更详情
  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等