Create a temporary workflow instance based on configurations.
Operation description
This API operation is available for all DataWorks editions.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:ExecuteAdhocWorkflowInstance | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| EnvType | string | No | The environment of the workspace. Valid values:
| Prod |
| Name | string | Yes | The name of the workflow instance. | WorkflowInstance1 |
| ProjectId | long | Yes | The workspace ID. | 100 |
| Owner | string | Yes | The account ID of the owner. | 1000 |
| BizDate | long | No | The data timestamp. | 1710239005403 |
| Tasks | array<object> | Yes | The tasks. | |
| Task | object | Yes | ||
| Name | string | Yes | The name of the task. | SQL node. |
| Type | string | Yes | The type of the task. | ODPS_SQL |
| Owner | string | Yes | The account ID of the owner. | 1000 |
| Timeout | integer | No | The timeout period of task running. Unit: seconds. | 3600 |
| Script | object | No | The script information. | |
| Content | string | No | The script content. | echo "helloWorld" |
| Parameters | string | No | The script parameters. | para1=$bizdate |
| RuntimeResource | object | Yes | The configurations of the runtime environment, such as the resource group information. | |
| ResourceGroupId | string | Yes | The ID of the resource group for scheduling configured for task running. | S_res_group_524258031846018_1684XXXXXXXXX |
| Image | string | No | The ID of the image configured for task running. | i-xxxxxx |
| Cu | string | No | The default number of compute units (CUs) configured for task running. | 0.25 |
| DataSource | object | No | The information about the associated data source. | |
| Name | string | No | The name of the data source. | mysql_test |
| Inputs | object | No | The input information. | |
| Variables | array<object> | No | The variables. | |
| Variable | object | No | ||
| Name | string | No | The name of the variable. | key1 |
| Value | string | No | The value of the variable. You must configure this parameter in the | Value1 |
| Outputs | object | No | The output information. | |
| TaskOutputs | array<object> | No | The task outputs. | |
| TaskOutput | object | No | ||
| Output | string | No | The identifier of the output. | pre.odps_sql_demo_0 |
| Variables | array<object> | No | The variables. | |
| Variable | object | No | ||
| Name | string | No | The name of the variable. | key1 |
| Type | string | No | The type. Valid values:
| Constant |
| Value | string | No | The value of the variable. | value1 |
| Dependencies | array<object> | No | The dependency information. | |
| Dependency | object | No | ||
| UpstreamOutput | string | No | The identifier of the output of the ancestor task. | pre.odps_sql_demo_0 |
| ClientUniqueCode | string | Yes | The unique code of the client. This code uniquely identifies a task. | Task_0bc5213917368545132902xxxxxxxx |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
"WorkflowInstanceId": 1234
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-03-20 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2025-02-11 | The internal configuration of the API is changed, but the call is not affected | View Change Details |