All Products
Search
Document Center

DataWorks:RunCycleDagNodes

Last Updated:Sep 03, 2024

Creates a workflow to backfill data.

Operation description

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectEnvstringYes

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.

PROD
StartBizDatestringYes

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

2020-05-20 00:00:00
NamestringYes

The name of the workflow.

xm_test
RootNodeIdlongYes

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

1234
ExcludeNodeIdsstringNo

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.

1234,123465
BizBeginTimestringNo

The time when the node starts 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.

00:00:00
BizEndTimestringNo

The time when the node stops 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.

01:00:00
ParallelismbooleanYes

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

false
EndBizDatestringYes

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

2020-05-21 00:00:00
NodeParamsstringNo

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.

{74324:"a=123 b=456"}
IncludeNodeIdsstringYes

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 obtain the node ID.

74324,74325
StartFutureInstanceImmediatelybooleanNo

Specifies whether to immediately run an instance that is scheduled to run in the future. If you set this parameter to true, the instance that is scheduled to run in the future is run immediately. Otherwise, the instance is run as scheduled.

false
ConcurrentRunsintegerNo

The number of nodes that can run in parallel. Valid values: 2 to 10.

5
AlertTypestringNo

The alert type. Valid values:

  • SUCCESS: An alert is generated when data backfill succeeds.
  • FAILURE: An alert is generated when data backfill fails.
  • SUCCESS_FAILURE: An alert is generated regardless of whether data backfill succeeds or fails.
FAILURE
AlertNoticeTypestringNo

The alert notification method. Valid values:

  • SMS
  • MAIL
  • SMS_MAIL
SMS

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The request ID. You can use the request ID to query logs and troubleshoot issues.

>E6F0DBDD-5AD****
ErrorMessagestring

The error message.

The connection does not exist.
Successboolean

Indicates whether the request was successful.

true
ErrorCodestring

The error code.

Invalid.Tenant.ConnectionNotExists
Dataarray

The IDs of the nodes in the workflow. You can query instances based on the IDs.

long

The ID of the node in the workflow.

111

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": ">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 Service error codes.

Change history

Change timeSummary of changesOperation
No change history