UpdateWorkflowDefinition - 更新数据开发工作流信息 - 大数据开发治理平台 DataWorks

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ProjectId	integer	是	DataWorks 工作空间的 ID，您可以登录 DataWorks 控制台，进入工作空间管理页面查看 ID。	10001
Id	string	是	数据开发工作流唯一标识符。重要该字段在 SDK8.0.0 版本之前为 Long 类型，SDK8.0.0 版本及之后为 String 类型。该变更不影响 SDK 正常使用，参数仍会按 SDK 中定义的类型返回。只有在跨 8.0.0 版本的 SDK 升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。	652567824470354XXXX
Spec	string	是	描述这个工作流的 FlowSpec 信息，具体规范详见 FlowSpec 。重要该接口只支持更新 Workflow 自身的信息，FlowSpec 描述的内部节点信息不会被更新。	{ "kind": "CycleWorkflow", "version": "1.1.0", "spec": { "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", "outputs": { "nodeOutputs": [ { "data": "workflow_output", "artifactType": "NodeOutput", "refTableName": "OpenAPI_Test_Workflow_Demo" } ] }, "dependencies": [] } ] } }

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求的 ID。用于定位日志，排查问题。	20BF7E80-668A-5620-8AD8-879B8FEA****
Success	boolean	是否调用成功，取值如下： true：调用成功。 false：调用失败。	true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。