CreateWorkflowInstances_大数据开发治理平台 DataWorks_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
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
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dataworks:CreateWorkflowInstances
Create
全部资源
*

请求参数

字段名称字段详情
ProjectIdinteger<int64>

项目 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:100参考取值来源:
    CreateProject
EnvTypestring

项目环境。展开详情

示例值:Prod枚举值:ProdDev
WorkflowIdinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1参考取值来源:
    GetWorkflow
    ListWorkflowInstances
    ExecuteAdhocWorkflowInstance
Namestring

名称。

示例值:WorkflowInstance1
Periodsobject

补数据周期设置。

Typestring

工作流实例的类型。展开详情

示例值:SupplementData枚举值:ManualWorkflowSupplementDataManualSmokeTest
WorkflowParametersstring

工作流参数,优先级高于任务参数。格式参考任务脚本参数(GetTask 接口的结果 Task.Script.Parameter)。

示例值:key1=value1 key2=value2
TaskParametersstring

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

示例值:{ "1001": "key1=val2 key2=val2", "1002": "key1=val2 key2=val2" }
AutoStartEnabledboolean

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

示例值:true
DefaultRunPropertiesobject

运行时配置。

Commentstring

创建的原因说明。

示例值:create for test

返回参数

字段名称字段详情
RequestIdstring

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

示例值:22C97E95-F023-56B5-8852-B1A77A17XXXX
OperationIdstring

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

示例值:e15ad21c-b0e9-4792-8f55-b037xxxxxxxx

返回示例

变更历史

变更时间变更内容概要操作
2025-02-27
变更请求参数Type
变更请求参数DefaultRunProperties
2025-01-22
新增OpenAPI,创建工作流实例

相关示例