CreateWorkflowDefinition - 创建数据开发工作流

调用该接口,在数据开发指定目录下创建一个工作流。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。

10000
Specstring

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

说明 如何快速获取 FlowSpec 模板?
  • 在数据开发中打开工作流->点击右上角“显示 Spec,即可得到针对当前工作流的 FlowSpec 描述。可以基于该 FlowSpec 描述快速构建符合要求的模板。
  • 注意 该接口只支持创建 Workflow,FlowSpec 描述的内部节点不会被创建出来。

    { "kind": "CycleWorkflow", "version": "1.1.0", "spec": { "name": "OpenAPITestWorkflowDemo", "type": "CycleWorkflow", "workflows": [ { "script": { "path": "XX/OpenAPITest/WorkflowTest/OpenAPITestWorkflowDemo", "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": "OpenAPITestWorkflowDemo", "outputs": { "nodeOutputs": [ { "data": "workflow_output", "artifactType": "NodeOutput", "refTableName": "OpenAPITestWorkflowDemo" } ] }, "dependencies": [] } ] } }

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

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

    0EF298E5-0940-5AC7-9CB0-6502507****
    Idlong

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

    注意 该字段在 SDK8.0.0 版本之前为 Long 类型,SDK8.0.0 版本及之后为 String 类型。该变更不影响 SDK 正常使用,参数仍会按 SDK 中定义的类型返回。只有在跨 8.0.0 版本的 SDK 升级时,类型变更可能会导致项目编译不通过,需要用户手动修正数据类型。

    463497880880954XXXX

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "0EF298E5-0940-5AC7-9CB0-6502507****",
      "Id": 0
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2025-01-13OpenAPI 返回结构发生变更查看变更详情