RunManualDagNodes

Triggers a manual workflow to run. The manual workflow must have been submitted and published in the environment page before it appears in the 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 identifier of the Operation Center. PROD indicates the production environment. DEV indicates the development environment. Valid values: PROD : Production environment. DEV : Development environment.	PROD or DEV
ProjectName	string	Yes	The English name of the workspace to which the manual workflow belongs.	test_workspace
FlowName	string	Yes	The name of the manual workflow.	test_workflow
BizDate	string	No	The business date. The value must be less than or equal to the current date minus 1 day. For example, if today is November 11, 2020, the business date must be 00:00:00 on November 10, 2020 or an earlier date. The hour, minute, and second values of the business date must all be set to 00. The StartBizDate and EndBizDate parameters must be used together. You can configure only one of BizDate or the StartBizDate and EndBizDate pair. Format: `yyyy-MM-dd HH:mm:ss`. Example: `2020-11-11 00:00:00`.	2020-11-11 00:00:00
NodeParameters	string	No	The node parameter information passed when the manual workflow is executed. This corresponds to the scheduling parameters configured in the Properties of nodes within the manual workflow. A JSON format: { "<Node ID within the manual workflow>": "Scheduling parameter information of the node, in the same format as the parameters in the Data Studio scheduling configuration", "<Node ID within the manual workflow>": "Scheduling parameter information of the node, in the same format as the parameters in the Data Studio scheduling configuration" }	{"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}
DagParameters	string	No	This parameter is synchronized to all instances of the current dagrun. If the scheduling parameters of internal nodes (supported node types) reference workflow parameters in DagParameters, the corresponding parameter values of the nodes are replaced with the workflow parameters in DagParameters.	{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}
IncludeNodeIds	string	No	The IDs of specific nodes to run within the manual workflow. Separate multiple node IDs with commas (,).	74324,74325
ExcludeNodeIds	string	No	The IDs of nodes that you do not want to run within the workflow. The specified nodes generate dry-run instances during execution. After a dry-run instance is scheduled, it immediately succeeds without executing the script content. Separate multiple node IDs with commas (,). The ExcludeNodeIds parameter takes effect only when used together with the IncludeNodeIds parameter.	123,456
ProjectId	integer	No	The project ID.	123
StartBizDate	string	No	The business start date. Format: yyyy-MM-dd HH:mm:ss. This parameter is used together with the EndBizDate parameter. You can configure only one of the StartBizDate and EndBizDate pair or the BizDate parameter.	2020-02-02 00:00:00
EndBizDate	string	No	The business end date. Format: yyyy-MM-dd HH:mm:ss. This parameter is used together with the StartBizDate parameter. You can configure only one of the StartBizDate and EndBizDate pair or the BizDate parameter.	2020-02-03 00:00:00

Response elements

Element	Type	Description	Example
	object	The response parameters.
DagId	integer	The instance ID of the dagrun for the manual workflow. You can use this DagId with the corresponding API operation to query the details and status of internal node instances for this manual workflow run.	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.