All Products
Search

This Product

    Data Management:BackFill

    Document Center

    Data Management:BackFill

    Last Updated:Apr 26, 2024

    Backfills data for a task flow.

    Operation description

    During a data backfill, task flows are run in sequence based on their dates. You can specify whether task flows are run in chronological or reverse chronological order. After the data backfill is complete, you can specify a date or date range, and a node range to run task flows.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    dms:BackFillRead
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    TidlongNo

    The ID of the tenant.

    Note To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.
    		3***
    DagIdlongYes

    The ID of the task flow. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to query the task flow ID.

    		15***
    StartNodeIdsarrayNo

    The number of nodes for which you want to backfill data.

    longNo

    The number of task nodes to be replenished.

    		2
    FilterNodeIdsarrayNo

    Filter condition, which specifies the list of node IDs in the task flow that do not need to supplement data.

    longNo

    The ID of the node that does not need to supplement data in the task flow.

    		12***
    IsTriggerSubTreebooleanNo

    Specifies whether to run descendant nodes. Default value: true.

    		true
    BackFillDatestringNo

    The date for the data to be backfilled. This parameter is required if you specify a date for data backfill.

    		2022-01-14
    BackFillDateBeginstringNo

    The start date of the date range for the data to be backfilled. This parameter is required if you specify a date range for data backfill.

    		2022-01-14
    BackFillDateEndstringNo

    The end date of the date range for the data to be backfilled. This parameter is required if you specify a date range for data backfill.

    		2022-09-29
    IntervalintegerNo

    The interval at which data backfill is performed. Unit: hours. Minimum value: 1. Default value: 24.

    		24
    AscbooleanNo

    The running sequence of task flows for data backfill. Valid values:

    • 0: reverse chronological order.
    • 1: chronological order. This is the default value.
    		0
    HistoryDagIdlongNo

    The ID of the historical task flow.

    		16***

    The BackFillDate parameter is required if you specify a date for data backfill.

    The BackFillDateBegin and BackFillDateEnd parameters are required if you specify a date range for data backfill.

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		7FAD400F-7A5C-4193-8F9A-39D86C4F0231
    ErrorCodestring

    The error code returned if the request failed.

    		UnknownError
    ErrorMessagestring

    The error message returned if the request failed.

    		UnknownError
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.
    • false: The request failed.
    		true
    DagInstanceIdlong

    The ID of the execution record of the task flow.

    		47****
    NodeIdlong

    The ID of the node.

    		43****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-05-25The request parameters of the API has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: FilterNodeIds
    Output ParametersThe response structure of the API has changed.