CreateLifecycleDataTask

Last updated:2026-03-11 22:54:46

CreateLifecycleDataTask

Last updated: 2026-03-11 22:54:46

1. API Description

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

Support proactive settlement/preheat API.

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: CreateLifecycleDataTask.
Version	Yes	String	Common Params. The value used for this API: 2019-07-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
FileSystemId	Yes	String	File system unique ID.
Type	Yes	String	Lifecycle task type; archive: settlement; restore: preheating; release: data release; metaload: metadata loading.
TaskPath	Yes	String	The path or file to be settled supports passing only one path and cannot be empty.
TaskName	Yes	String	Task name.
DataFlowId	No	String	Data flow ID. this api can be accessed through DescribeDataFlow.
IsOverwrite	No	Boolean	When a file in CFS Turbo and an external storage have the same name, whether to overwrite. true: overwrite. false: not overwrite (at the same time, data storage will not be released). default false when empty.

3. Output Parameters

Parameter Name	Type	Description
TaskId	String	Task ID.
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 CreateLifecycleDataTask

Input Example

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

{
    "FileSystemId": "cfs-4agcdretg",
    "Type": "archive",
    "TaskPath": "/cfs/data",
    "TaskName": "dataarchive"
}

Output Example

{
    "Response": {
        "TaskId": "task-abcdefg",
        "RequestId": "req-gagagagagag"
    }
}

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
InvalidParameterValue.InvalidDataFlowId	Parameter value error: data flow ID invalid.
InvalidParameterValue.InvalidDataFlowSourceStorageType	Parameter value error: data flow source storage type invalid.
InvalidParameterValue.InvalidDataFlowTargetPath	Parameter value error: data flow target path invalid.
InvalidParameterValue.InvalidFileSystemId	`FileSystemId` is invalid.
InvalidParameterValue.InvalidFsStatus	Invalid file system status.
InvalidParameterValue.InvalidLifecycleDataTaskType	Parameter value error: lifecycle task type invalid.
InvalidParameterValue.WaitingTaskLimitExceeded	The number of lifecycle data tasks exceeds the limit.

Was this page helpful?

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

Yes

Feedback

tencent cloud