根据配置创建一个临时工作流实例。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dataworks:ExecuteAdhocWorkflowInstance | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
EnvType | string | 否 | 项目环境。
| Prod |
Name | string | 是 | 名称。 | WorkflowInstance1 |
ProjectId | long | 是 | 项目 ID。 | 100 |
Owner | string | 是 | 责任人的账号 ID。 | 1000 |
BizDate | long | 否 | 业务日期。格式为时间戳。 | 1710239005403 |
Tasks | array<object> | 是 | 任务列表。 | |
Task | object | 是 | ||
Name | string | 是 | 任务的名称。 | SQL node. |
Type | string | 是 | 任务类型。 | ODPS_SQL |
Owner | string | 是 | 责任人的账号 ID。 | 1000 |
Timeout | integer | 否 | 任务执行超时时间,单位为秒。 | 3600 |
Script | object | 否 | 运行脚本信息。 | |
Content | string | 否 | 脚本内容。 | echo "helloWorld" |
Parameters | string | 否 | 脚本参数列表。 | para1=$bizdate |
RuntimeResource | object | 是 | 运行环境配置,如资源组信息。 | |
ResourceGroupId | string | 是 | 任务运行配置的调度资源组标识符。 | S_res_group_524258031846018_1684XXXXXXXXX |
Image | string | 否 | 任务运行配置的镜像 ID。 | i-xxxxxx |
Cu | string | 否 | 任务运行配置 CU 消耗。 | 0.25 |
DataSource | object | 否 | 关联数据源信息。 | |
Name | string | 否 | 数据源名称。 | mysql_test |
Inputs | object | 否 | 输入信息。 | |
Variables | array<object> | 否 | 变量定义列表。 | |
Variable | object | 否 | ||
Name | string | 否 | 变量名称。 | key1 |
Value | string | 否 | 变量值。请以 | upstream_task_output:key1 |
Outputs | object | 否 | 输出信息。 | |
TaskOutputs | array<object> | 否 | 任务输出定义列表。 | |
TaskOutput | object | 否 | ||
Output | string | 否 | 输出标识符。 | pre.odps_sql_demo_0 |
Variables | array<object> | 否 | 变量定义列表。 | |
Variable | object | 否 | ||
Name | string | 否 | 变量名称。 | key1 |
Type | string | 否 | 类型。
| Constant |
Value | string | 否 | 变量值。 | value1 |
Dependencies | array<object> | 否 | 依赖信息。 | |
Dependency | object | 否 | ||
UpstreamOutput | string | 否 | 依赖任务的输出标识符。 | pre.odps_sql_demo_0 |
ClientUniqueCode | string | 是 | 任务的客户端唯一码,用来唯一标识一个任务。 | Task_0bc5213917368545132902xxxxxxxx |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
"WorkflowInstanceId": 1234
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2025-03-20 | API 内部配置变更,不影响调用 | 查看变更详情 |
2025-02-11 | API 内部配置变更,不影响调用 | 查看变更详情 |