Backfill Workflow Data via the BackFill API - Data Management - Alibaba Cloud - Data Management

Calls the BackFill operation to backfill data for a task flow.

Operation description

During data backfill, the task flow performs sequential execution by date. You can specify ascending or descending order by date to execute. After the data backfill is complete, you can specify a date or date range and a node range to run the task flow.

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

dms:BackFill

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The tenant ID. Note You can find the tenant ID by hovering over the profile picture in the upper-right corner of the console. For more information, see View tenant information.	3***
DagId	integer	Yes	The ID of the task flow. You can obtain this parameter by calling the ListTaskFlow or ListLhTaskFlowAndScenario operation.	15***
StartNodeIds	array	No	The list of start node IDs for data backfill. Note If this parameter is not specified, the entire task flow is run.
	integer	No	The number of task nodes to backfill data for.	2
FilterNodeIds	array	No	The filter condition. Specifies the list of node IDs in the task flow that do not require data backfill.
	integer	No	The ID of a node in the task flow that does not require data backfill.	12***
IsTriggerSubTree	boolean	No	Specifies whether to run downstream nodes. Default value: true.	true
BackFillDate	string	No	The business time for data backfill. This parameter is required when you backfill data for a specified date.	2022-01-14
BackFillDateBegin	string	No	The start business time for data backfill. This parameter is required when you backfill data for a specified date range.	2022-01-14
BackFillDateEnd	string	No	The end business time for data backfill. This parameter is required when you backfill data for a specified date range.	2022-09-29
Interval	integer	No	The data timestamp interval for data backfill. Unit: hours. Minimum value: 1. Default value: 24.	24
Asc	boolean	No	The execution order of the data backfill task flow. Valid values: 0: descending order. Runs from the latest date to the earliest date. 1: default value. Ascending order. Runs from the earliest date to the latest date.	0
HistoryDagId	integer	No	The ID of the historical task flow. Note If you do not specify this parameter, the system automatically retrieves the ID of the most recently published task flow version. If no task flow has been published, the system cannot retrieve the task flow version ID, and the call fails.	16***

To backfill data for a specified date, provide the BackFillDate parameter.
To backfill data for a specified date range, provide the BackFillDateBegin and BackFillDateEnd parameters.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message returned if the call failed.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
DagInstanceId	integer	The ID of the task flow execution record. You can obtain this parameter by calling the ListTaskFlowInstance operation.	47****
NodeId	integer	Same as DagInstanceId.	47****

Examples

Success response

JSON format

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "DagInstanceId": 0,
  "NodeId": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.