全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：CreateWorkflowInstances - 创建工作流实例

    文档中心

    大数据开发治理平台 DataWorks：CreateWorkflowInstances - 创建工作流实例

    更新时间：Sep 03, 2026

    根据配置创建工作流实例，如补数据工作流实例。

    接口说明

    需要购买 DataWorks 基础版及以上版本才能使用。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dataworks:CreateWorkflowInstances

    create

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    ProjectId

    integer

    是

    项目 ID。

    100
    EnvType

    string

    否

    项目环境。

    • Prod：生产

    • Dev：开发

    枚举值：

    • Prod :

      生产

    • Dev :

      开发

    Prod
    WorkflowId

    integer

    是

    所属工作流的 ID。周期任务的 WorkflowId 均为 1。

    1
    Name

    string

    是

    名称。

    WorkflowInstance1
    Periods

    object

    否

    补数据周期设置。

    BizDates

    array<object>

    是

    业务日期列表。可指定多段业务日期（最多 7 段）。

    object

    否

    StartBizDate

    string

    是

    起始业务日期。格式为yyyy-mm-dd。

    2024-11-20
    EndBizDate

    string

    是

    结束业务日期。格式为yyyy-mm-dd。

    2024-11-24
    StartTime

    string

    否

    指定开始周期时间，格式为hh:mm:ss，24 小时制，默认 00:00:00。

    如果填写此字段需要 StartTime 与 EndTime 需要同时填写。

    00:00:00
    EndTime

    string

    否

    指定结束周期时间，格式为hh:mm:ss，24 小时制，默认 23:59:59。

    如果填写此字段需要 StartTime 与 EndTime 需要同时填写。

    23:59:59
    Type

    string

    是

    工作流实例的类型。

    • SupplementData：补数据。RootTaskIds 与 IncludeTaskIds 的填写方法随补数据模式而变化，见 DefaultRunProperties.Mode 参数说明

    • ManualWorkflow：手动业务流程。WorkflowId 需要填手动业务流程的 WorkflowId，RootTaskIds 选填，不填则会使用手动业务流程默认的根节点列表。

    • Manual：手动任务。仅需填 RootTaskIds，即为要运行的手动任务列表。

    • SmokeTest：冒烟测试。仅需填 RootTaskIds，即为要运行的测试任务列表。

    • TriggerWorkflow：触发式工作流。WorkflowId 需要填触发式工作流的 WorkflowId，IncludeTaskIds 选填，不填则会运行整个工作流。

    枚举值：

    • SmokeTest :

      冒烟测试。仅需填 RootTaskIds，即为要运行的测试任务列表

    • TriggerWorkflow :

      触发式工作流。WorkflowId 需要填触发式工作流的 WorkflowId，IncludeTaskIds 选填，不填则会运行整个工作流

    • Manual :

      手动任务。仅需填 RootTaskIds，即为要运行的手动任务列表

    • SupplementData :

      补数据。RootTaskIds 与 IncludeTaskIds 的填写方法随补数据模式而变化，见 DefaultRunProperties.Mode 参数说明

    • ManualWorkflow :

      手动业务流程。WorkflowId 需要填手动业务流程的 WorkflowId，RootTaskIds 选填，不填则会使用手动业务流程默认的根节点列表

    SupplementData
    WorkflowParameters

    string

    否

    工作流参数，当指定唯一工作流（WorkflowId != 1）时生效。若为周期工作流、触发式工作流，格式为 key=value，优先级低于任务参数；若为手动业务流程，格式为 JSON，优先级高于任务参数。

    "key=value" format: key1=value1 key2=value2 JSON format: {"key1":"value1", "key2": "value2"}
    TaskParameters

    string

    否

    任务参数，为特定任务设置参数。JSON 格式，key 为任务 ID，value 的格式参考任务脚本参数（GetTask 接口的结果 Task.Script.Parameter）。

    { "1001": "key1=val2 key2=val2", "1002": "key1=val2 key2=val2" }
    AutoStartEnabled

    boolean

    否

    创建后是否直接运行，默认为 true。

    true
    DefaultRunProperties

    object

    否

    运行时配置。

    RootTaskIds

    array

    否

    根任务 ID 列表。

    • Type=SupplementData 时。除 Mode=Chain 的情况外，RootTaskIds 均必填。

    • Type=ManualWorkflow 时。RootTaskIds 选填，不填则会使用手动业务流程默认的根节点列表。

    • Type=Manual 时。RootTaskIds 必填，即为要运行的手动任务列表。

    • Type=SmokeTest 时：RootTaskIds 必填，即为要运行的测试任务列表。

    integer

    否

    任务 ID。

    1234
    IncludeTaskIds

    array

    否

    需要运行的任务 ID 列表。

    integer

    否

    任务 ID。

    1234
    ExcludeTaskIds

    array

    否

    不要运行的任务 ID 列表。

    integer

    否

    任务 ID。

    4321
    IncludeProjectIds

    array

    否

    需要运行的项目 ID 列表。

    integer

    否

    项目 ID。

    100
    ExcludeProjectIds

    array

    否

    不需要运行的项目 ID 列表。

    integer

    否

    项目 ID。

    200
    Mode

    string

    否

    补数据模式，默认为 ManualSelection。Type=SupplementData 时必填。

    • General：普通模式，RootTaskIds仅能填一个，IncludeTaskIds选填，不填会默认包含RootTaskIds中的内容

    • ManualSelection：手动选择，RootTaskIds能填多个，IncludeTaskIds选填，不填会默认包含RootTaskIds中的内容

    • Chain：链路，RootTaskIds为空，IncludeTaskIds填两个 id，分别是起始和结束任务

    • AllDownstream：所有下游，RootTaskIds仅能填一个

    ManualSelection
    Analysis

    object

    否

    分析配置。Type=SupplementData 时必填。

    Enabled

    boolean

    否

    是否开启分析。Type=SupplementData 时必填。

    true
    Blocked

    boolean

    否

    分析不通过的情况下是否阻塞运行。Type=SupplementData 时必填。

    true
    RunPolicy

    object

    否

    运行策略。该字段为空则跟随任务配置。

    StartTime

    string

    否

    开始运行时间，格式为hh:mm:ss，24 小时制。若设置运行策略，此字段必填。

    00:00:00
    EndTime

    string

    否

    结束运行时间，格式为hh:mm:ss，24 小时制。若设置运行策略，此字段必填。

    23:59:59
    Type

    string

    否

    时段类型。若设置运行策略，此字段必填。

    • Daily：每天

    • Weekend：仅周末

    枚举值：

    • Daily :

      每天

    • Weekend :

      仅周末

    Daily
    Immediately

    boolean

    否

    运行时间在未来是否可以立即运行起来，默认为 false。

    false
    Alert

    object

    否

    报警配置。

    Type

    string

    否

    报警策略。

    • Success 成功告警

    • Failure 失败告警

    • SuccessFailure 成功和失败都告警

    枚举值：

    • SuccessFailure :

      成功和失败都告警

    • Failure :

      失败告警

    • Success :

      成功告警

    Succes
    NoticeType

    string

    否

    通知方式。

    • Sms：仅短信

    • Mail：仅邮件

    • SmsMail：短信加邮件。

    枚举值：

    • Mail :

      仅邮件

    • Sms :

      仅短信

    • SmsMail :

      短信加邮件

    Sms
    Parallelism

    integer

    否

    任务并行数。取值 2~10 时为并行度， 取值 1 时为串行。Type=SupplementData 时必填。

    2
    Order

    string

    否

    运行顺序，默认为 Asc。

    • Asc：按业务日期升序。

    • Desc：按业务日期降序。

    枚举值：

    • Asc :

      按业务日期升序

    • Desc :

      按业务日期降序

    Asc
    RuntimeResource

    string

    否

    自定义调度资源组标识符，该字段为空则跟随任务配置。

    S_res_group_524258031846018_1684XXXXXXXXX
    Priority

    integer

    否

    运行优先级，取值范围为 1~11。取值越大，优先级越高。（该参数配置只支持手动业务流程与触发式工作流）

    1
    PriorityWeightStrategy

    string

    否

    优先级权重策略。（该参数配置只支持手动业务流程与触发式工作流）

    • Disable：不启用（默认）

    • Upstream：当前节点计算上游的权重总和。即层次越深，权重越高。

    Upstream
    Comment

    string

    否

    创建的原因说明。

    create for test
    Tags

    array<object>

    否

    任务标签列表。

    object

    否

    Value

    string

    否

    标签值。

    tagValue
    Key

    string

    否

    标签键。

    tagKey
    TagCreationPolicy

    string

    否

    标签创建策略。

    • Append：追加模式，在继承手动业务流程已有标签的基础上追加新的标签。

    • Overwrite：覆盖模式，不继承手动业务流程已有标签，直接创建标签。

    枚举值：

    • Overwrite :

      覆盖模式，不继承手动业务流程已有标签，直接创建标签

    • Append :

      追加模式，在继承手动业务流程已有标签的基础上追加新的标签

    Append

    返回参数

    名称

    类型

    描述

    示例值

    object

    RequestId

    string

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

    22C97E95-F023-56B5-8852-B1A77A17XXXX
    OperationId

    string

    操作 ID。您可以凭借此字段通过 GetCreateWorkflowInstancesResult 接口来查询创建操作的结果。

    e15ad21c-b0e9-4792-8f55-b037xxxxxxxx

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "OperationId": "e15ad21c-b0e9-4792-8f55-b037xxxxxxxx"
}

    错误码

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

    变更历史

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