Creates a workflow to backfill data.

For more information about data backfill, see Backfill data.

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 RunCycleDagNodes

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

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 that is used to call the operation.

ProjectEnv String Yes PROD

The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.

StartBizDate String Yes 2020-05-20 00:00:00

The data timestamp at which data starts to be backfilled. Specify the value in the yyyy-MM-dd 00:00:00 format.

Name String Yes xm_test

The name of the workflow.

RootNodeId Long Yes 1234

The ID of the node for which data is first backfilled. You can call the ListNodes operation to query the ID.

ExcludeNodeIds String No 1234,123465

The IDs of the nodes for which no data needs to be backfilled. The system generates dry-run instances for all these nodes. After these dry-run instances are scheduled, the statuses of these instances are directly set to successful, but the script is not run.

BizBeginTime String No 00:00:00

The time when the node started to run. This parameter is required only for auto triggered nodes that are scheduled by hour. Specify the value in the HH:mm:ss format. Valid values: 00:00:00 to 23:59:59.

BizEndTime String No 01:00:00

The time when the node stopped running. This parameter is required only for auto triggered nodes that are scheduled by hour. Specify the value in the HH:mm:ss format. Valid values: 00:00:00 to 23:59:59.

Parallelism Boolean Yes false

Specifies whether data can be backfilled for multiple nodes at the same time.

EndBizDate String Yes 2020-05-21 00:00:00

The data timestamp at which data is no longer backfilled. Specify the value in the yyyy-MM-dd 00:00:00 format.

NodeParams String No null

The parameters that need to be configured for the node. Set this parameter to a JSON string. The key indicates the ID of the node, and the value indicates the actual values of the parameters.

IncludeNodeIds String Yes 74324,74325

The ID of the node for which you want to backfill data. If you want to backfill data for multiple nodes, separate the IDs of the nodes with commas (,). You can call the ListNodes operation to query the IDs.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String >E6F0DBDD-5AD****

The ID of the request. You can locate logs and troubleshoot issues based on the ID.

ErrorMessage String The connection does not exist.

The error message returned.

Success Boolean true

Indicates whether the request is successful.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code returned.

Data Array of Long 111

The IDs of the nodes in the workflow.

Examples

Sample requests

http(s)://[Endpoint]/?Action=RunCycleDagNodes
&ProjectEnv=PROD
&StartBizDate=2020-05-20 00:00:00
&Name=xm_test
&RootNodeId=1234
&ExcludeNodeIds=1234,123465
&BizBeginTime=00:00:00
&BizEndTime=01:00:00
&Parallelism=false
&EndBizDate=2020-05-21 00:00:00
&NodeParams={74324:"key1=val1 key2=val"}
&IncludeNodeIds=74324,74325
&<Common request parameters>

Sample success responses

XML format

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

<RunCycleDagNodesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>&gt;E6F0DBDD-5AD****</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Data>111</Data>
</RunCycleDagNodesResponse>

JSON format

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "&gt;E6F0DBDD-5AD****",
  "ErrorMessage" : "The connection does not exist.",
  "Success" : true,
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Data" : 111
}

Error codes

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