All Products
Search
Document Center

:RunManualDagNodes

更新時間:Mar 19, 2024

Runs nodes in a manually triggered workflow. Before you call this operation, make sure that the manually triggered workflow is created, committed, and deployed. You can find the manually triggered workflow in Operation Center only after the manually triggered workflow is committed and deployed. For more information about how to create, commit, and deploy a workflow, see CreateBusiness, SubmitFile, and DeployFile.

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.

ProjectEnv

String

Yes

PROD or DEV

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

ProjectName

String

Yes

test_workspace

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

FlowName

String

Yes

test_workflow

The name of the manually triggered workflow.

BizDate

String

No

2020-11-11 00:00:00

The data timestamp. The value of the data timestamp 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. Configure this parameter in the YYYY-MM-DD 00:00:00 format.

The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.

NodeParameters

String

No

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

The scheduling parameters of nodes in the manually triggered workflow. Configure NodeParameters 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 parameter settings in the Parameters section of the Properties tab on 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 parameter settings in the Parameters section of the Properties tab on the DataStudio page"}.

DagParameters

String

No

{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}

The parameters 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 (,).

ExcludeNodeIds

String

No

123,456

The IDs of the nodes that you do not need to run in the manually triggered workflow. DataWorks 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 (,).

The ExcludeNodeIds parameter must be used together with the IncludeNodeIds parameter. This way, the settings of the ExcludeNodeIds parameter can take effect.

ProjectId

Long

No

123

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

StartBizDate

String

No

2020-02-02 00:00:00

The beginning of the time range in which data generated needs to be processed. Configure this parameter in the yyyy-MM-dd HH:mm:ss format.

The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.

EndBizDate

String

No

2020-02-03 00:00:00

The end of the time range in which data generated needs to be processed. Configure this parameter in the yyyy-MM-dd HH:mm:ss format.

The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.

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 states of the nodes in the manually triggered workflow.

RequestId

String

AASFDFSDFG-DFSDF-DFSDFD-SDFSDF

The request ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=RunManualDagNodes
&ProjectEnv=PROD or DEV
&ProjectName=test_workspace
&FlowName=test_workflow
&BizDate=2020-11-11 00:00:00
&NodeParameters={"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}
&DagParameters={"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}
&IncludeNodeIds=74324,74325
&ExcludeNodeIds=123,456
&ProjectId=123
&StartBizDate=2020-02-02 00:00:00
&EndBizDate=2020-02-03 00:00:00
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.