RunCycleDagNodes

Creates a data backfill workflow by calling RunCycleDagNodes.

Operation description

For more information about data backfill, see Data backfill.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectEnv	string	Yes	The environment of the workspace. PROD indicates the production environment. DEV indicates the development environment. Valid values: PROD : production environment. DEV : development environment.	PROD
StartBizDate	string	Yes	The start business date for data backfill. Format: yyyy-MM-dd 00:00:00.	2020-05-20 00:00:00
Name	string	Yes	The name of the workflow.	xm_test
RootNodeId	integer	Yes	The ID of the start node for data backfill. You can call the ListNodes operation to obtain the node ID.	1234
ExcludeNodeIds	string	No	The list of node IDs that do not require data backfill. Nodes in this list generate dry-run instances. After a dry-run instance is scheduled, it directly succeeds without executing the script content.	1234,123465
BizBeginTime	string	No	The start time of the node. This parameter is required only for hourly scheduled nodes. Format: HH:mm:ss. Valid values: 00:00:00 to 23:59:59.	00:00:00
BizEndTime	string	No	The end time of the node. This parameter is required only for hourly scheduled nodes. Format: HH:mm:ss. Valid values: 00:00:00 to 23:59:59.	01:00:00
Parallelism	boolean	Yes	Specifies whether nodes across multiple business dates can run in parallel.	false
EndBizDate	string	Yes	The end business date for data backfill. Format: yyyy-MM-dd 00:00:00.	2020-05-21 00:00:00
NodeParams	string	No	A JSON string in which the key is the node ID and the value is the actual parameter value.	{"74324":"a=123 b=456"}
IncludeNodeIds	string	Yes	The node IDs for data backfill. Separate multiple node IDs with commas (,). You can call the ListNodes operation to obtain node IDs.	74324,74325
StartFutureInstanceImmediately	boolean	No	Specifies whether to immediately run instances whose scheduling time is in the future. If this parameter is set to true, instances with a scheduling time later than the current time run immediately. Otherwise, the instances wait until the scheduling time.	false
ConcurrentRuns	integer	No	The number of concurrent nodes. Valid values: 2 to 10.	5
AlertType	string	No	The alert type. Valid values: SUCCESS: Alerting on success. FAILURE: Alerting on failed. SUCCESS_FAILURE: Alerting on success or failed. Valid values: SUCCESS : Alert on success. SUCCESS_FAILURE : Alert on success or failure. FAILURE : Alert on failure.	FAILURE
AlertNoticeType	string	No	The alert notification method. Valid values: SMS: text message. MAIL: email. SMS_MAIL: text message and email. Valid values: MAIL : email. SMS : text message. SMS_MAIL : text message and email.	SMS

Response elements

Element	Type	Description	Example
	object	The response entity.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID. You can use this ID to locate logs and troubleshoot issues.	>E6F0DBDD-5AD****
ErrorMessage	string	The error message.	The connection does not exist.
Success	boolean	Indicates whether the call was successful.	true
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Data	array	The DagId returned when backfilling data for a scheduled task. You can use this DagId to query the corresponding instances.
	integer	The list of workflow IDs.	111

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.