Runs nodes in a manually triggered workflow. Before you call this operation, make sure that the manually triggered workflow is committed and deployed. You can find the manually triggered workflow on the Operation Center page only after the manually triggered workflow is committed and deployed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes RunManualDagNodes

The operation that you want to perform. Set the value to RunManualDagNodes.

BizDate String Yes 2020-11-11 00:00:00

The data timestamp. The value must be one or more days before the current date. For example, if the current date is November 11, 2020, set the value to 2020-11-10 00:00:00 or earlier. Specify this parameter in the YYYY-MM-DD 00:00:00 format.

FlowName String Yes test_workflow

The name of the manually triggered workflow.

ProjectEnv String Yes PROD or DEV

The environment type. Valid values: PROD and DEV. A value of PROD indicates the production environment. A value of DEV indicates the development environment.

ProjectName String Yes test_workspace

The name of the workspace to which the manually triggered workflow belongs.

RegionId String Yes cn-shanghai

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation.

NodeParameters String No {"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}

The parameters transmitted between nodes in the manually triggered workflow. The parameters are in the following JSON format: { "<ID of a node in the manually triggered workflow>": "Scheduling parameter settings of the node, which are in the same format as the Parameters parameter on the Properties tab of the DataStudio page", "<ID of a node in the manually triggered workflow>": "Scheduling parameter settings of the node, which are in the same format as the Parameters parameter on the Properties tab of the DataStudio page" }.

DagParameters String No {"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}

The parameters of the manually triggered workflow, which are synchronized to all the instances in the directed acyclic graph (DAG) of the workflow. If a workflow parameter specified in DagParameters is referenced as a scheduling parameter of a node, the value of the scheduling parameter is replaced with the value of the workflow parameter.

IncludeNodeIds String No 74324,74325

The IDs of the nodes that you need to run in the manually triggered workflow. Separate multiple node IDs with commas (,). You can call the ListNodes operation to query the node IDs.

ExcludeNodeIds String No 123,456

The IDs of the nodes that you do not need to run in the manually triggered workflow. The system generates dry-run instances for all these nodes. After the dry-run instances are scheduled, the states of these instances are directly set to successful, but the scripts are not run. Separate multiple node IDs with commas (,).

ProjectId Long No 123

The ID of the workspace to which the manually triggered workflow belongs.

Response parameters

Parameter Type Example Description
DagId Long 700000123123141

The ID of the DAG for the manually triggered workflow. You can call an operation with this parameter as a request parameter to query the details and statuses of the nodes in this manually triggered workflow.

RequestId String AASFDFSDFG-DFSDF-DFSDFD-SDFSDF

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=RunManualDagNodes
&BizDate=2020-11-11 00:00:00
&FlowName=test_workflow
&NodeParameters={"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}
&ProjectEnv=PROD or DEV
&ProjectName=test_workspace
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>AASFDFSDFG-DFSDF-DFSDFD-SDFSDF</RequestId>
<DagId>700000123123141</DagId>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.