CreateDataBackfillPlan

Last updated:2025-11-13 20:54:37

CreateDataBackfillPlan

Last updated: 2025-11-13 20:54:37

1. API Description

Domain name for API request: wedata.intl.tencentcloudapi.com.

This API is used to create a data backfill plan.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: CreateDataBackfillPlan.
Version	Yes	String	Common Params. The value used for this API: 2025-08-06.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
ProjectId	Yes	String	Project ID
TaskIds.N	Yes	Array of String	Backfill task collection.
DataBackfillRangeList.N	Yes	Array of DataBackfillRange	Specifies the data time configuration for the backfill task.
TimeZone	No	String	Time zone, default UTC+8.
DataBackfillPlanName	No	String	Backfill plan name. if left empty, a string of characters is randomly generated by system.
CheckParentType	No	String	Check parent task type. valid values: NONE (do not check ALL), ALL (check ALL upstream parent tasks), MAKE_SCOPE (only check in the currently selected tasks of the backfill plan). default: NONE (do not check).
SkipEventListening	No	Boolean	Specifies whether to ignore event dependency for backfill. default true.
RedefineSelfWorkflowDependency	No	String	Custom workflow self-dependency. valid values: yes or no. if not configured, use the original workflow self-dependency.
RedefineParallelNum	No	Integer	Customizes the degree of concurrency for instance running. if without configuring, use the existing self-dependent of the task.
SchedulerResourceGroupId	No	String	Scheduling resource group id. if left empty, indicates usage of the original task scheduling execution resource group.
IntegrationResourceGroupId	No	String	Integration task resource group id. indicates usage of the original task scheduling execution resource group if empty.
RedefineParamList.N	No	Array of KVPair	Custom parameter. re-specifies the task's parameters to facilitate the execution of new logic by replenished instances.
DataTimeOrder	No	String	Backfill Execution Order - The execution order for backfill instances based on their data time. Effective only when both conditions are met: 1. Must be the same cycle task. 2. Priority is given to dependency order. If no dependencies apply, execution follows the configured order. Valid values: -NORMAL: No specific order (default) -ORDER: Execute in chronological order -REVERSE: Execute in reverse chronological order
RedefineCycleType	No	String	Backfill Instance Regeneration Cycle - If set, this will redefine the generation cycle of backfill task instances. Currently, only daily instances can be converted into instances generated on the first day of each month. Valid value: MONTH_CYCLE: Monthly

3. Output Parameters

Parameter Name	Type	Description
Data	CreateDataReplenishmentPlan	Specifies the creation result of the data backfill plan.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a Backfill Skip Event

Input Example

POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDataBackfillPlan
<Common request parameters>

{
    "ProjectId": "1460947878944567296",
    "TaskIds": [
        "20250827115253729"
    ],
    "DataBackfillRangeList": [
        {
            "StartDate": "2025-09-02",
            "EndDate": "2025-09-02"
        }
    ],
    "SkipEventListening": true
}

Output Example

{
    "Response": {
        "Data": {
            "DataBackfillPlanId": "0726eb7b-0ffc-4ed7-8be4-2ef189645209"
        },
        "RequestId": "2ba8b5eb-b98f-4ad2-9bab-0960fa346c18"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
InvalidParameter	Parameter error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud