A topic is added to describe how to call the CreateManualDag operation to manually trigger a workflow. The manually triggered workflow must have been submitted and published on the page. You can access the corresponding manually triggered workflow before using the API.

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 CreateManualDag

The operation that you want to perform.

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

The value of business date is less than or equal to the current date -1 day. For example, if the current day is November 11, 2020, the business date must be 00:00:00 of November 10, 2020 or before that date. The hour, minute, and second information of the business date must be filled in with 00.

FlowName String Yes test_workflow

The name of the manually triggered workflow.

RegionId String Yes cn-shanghai

The information about the region, which is usually the region where the service is located. For example, China (Shanghai) is cn-shanghai, and China (Zhangjiakou) is cn-zhangjiakou. You do not need to specify the RegionId because it is automatically resolved based on the endpoint that is called.

ProjectEnv String Yes PROD or DEV

The environment variable of the scheduling center. In the project mode switch, PROD indicates the project in PROD mode and DEV indicates the project in DEV Mode.

ProjectName String Yes test_workspace

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

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

The node parameter information when the manually triggered workflow is run, in JSON format:

{"<a manually triggered workflow node ID>": "The scheduling parameter information of the node, which is consistent with the parameter format in the data development scheduling configuration", "<a node ID in the manually triggered workflow>": "The scheduling parameter information of the node, the format is the same as the format of the parameters in the data development and scheduling configuration"}
DagParameters String No {"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}

Workflow parameter. This parameter will be synchronized to all instances in the Dag. If the inner node of the scheduling parameter references the workflow parameter in DagParameters, the corresponding parameter value of the node is replaced with the workflow parameter in DagParameter.

Response parameters

Parameter Type Example Description
DagId Long 700000123123141

Manually triggered workflow ID of the instance where the Dag runs. You can use the interface and DagId to query the detailed information and status of manually triggered workflow instances running in this inner node.

RequestId String AASFDFSDFG-DFSDF-DFSDFD-SDFSDF

The request ID.

Examples

Sample requests


     http(s)://[Endpoint]/? Action=CreateManualDag &BizDate=2020-11-11 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

Go to the Error CenterFor more information, see error codes.