RunManualDagNodes

Runs nodes in a manually triggered workflow. The workflow must be committed and deployed before it appears in Operation Center and can be triggered by this operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectEnv	string	Yes	The environment of Operation Center. Valid values: PROD (production) and DEV (development).	PROD or DEV
ProjectName	string	Yes	The name of the workspace to which the manually triggered workflow belongs.	test_workspace
FlowName	string	Yes	The name of the manually triggered workflow.	test_workflow
BizDate	string	No	The data timestamp. Must be at least one day before the current date. Format: YYYY-MM-DD 00:00:00. Specify either BizDate alone or the StartBizDate and EndBizDate pair.	2020-11-11 00:00:00
NodeParameters	string	No	The scheduling parameters for nodes in the workflow. JSON format: {"<node_id>": "key=value pairs matching the Scheduling Parameter section on the DataStudio Properties tab"}.	{"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}
DagParameters	string	No	Parameters synchronized to all instances in the DAG. If a DagParameters value is referenced as a scheduling parameter of a node, it overrides the scheduling parameter value.	{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}
IncludeNodeIds	string	No	The IDs of the nodes that you need to run in the manually triggered workflow. Separate multiple node IDs with commas (,).	74324,74325
ExcludeNodeIds	string	No	The IDs of nodes to skip. DataWorks creates dry-run instances for these nodes and marks them as successful without running their scripts. Separate multiple IDs with commas (,). Must be used together with IncludeNodeIds.	123,456
ProjectId	integer	No	The ID of the workspace to which the manually triggered workflow belongs.	123
StartBizDate	string	No	The start of the data processing time range. Format: yyyy-MM-dd HH:mm:ss. Use with EndBizDate. Specify either BizDate alone or the StartBizDate and EndBizDate pair.	2020-02-02 00:00:00
EndBizDate	string	No	The end of the data processing time range. Format: yyyy-MM-dd HH:mm:ss. Use with StartBizDate. Specify either BizDate alone or the StartBizDate and EndBizDate pair.	2020-02-03 00:00:00

Response elements

Element	Type	Description	Example
	object	The response parameters.
DagId	integer	The DAG ID of the manually triggered workflow. Use this ID as a request parameter in other operations to query node details and states.	700000123123141
RequestId	string	The request ID.	AASFDFSDFG-DFSDF-DFSDFD-SDFSDF

Examples

Success response

JSON format

{
  "DagId": 700000123123141,
  "RequestId": "AASFDFSDFG-DFSDF-DFSDFD-SDFSDF"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.