tencent cloud



Last updated: 2023-07-04 17:30:02

1. API Description

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

This API is used to create a migration task.
To use this API, submit a ticket for us to add you to the allowlist.

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: CreateMigrationTask.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
TaskName Yes String Migration task name
MigrationType Yes Integer Migration type. Valid values: 0 (bucket) and 1 (list). Default value: 0.
MigrationMode Yes Integer Migration mode. Default value: 0 (full migration).
SrcSecretId Yes String SecretId of the data source account
SrcSecretKey Yes String SecretKey of the data source account
FileSystemId Yes String File system instance ID
FsPath Yes String File system path
CoverType Yes Integer Overwrite policy for files with the same name. Valid values: 0 (retain the file with the latest modified time), 1 (overwrite); and 2 (not overwrite). Default value: 0.
SrcService Yes String Data source service provider. Valid values: COS (Tencent Cloud COS), OSS (Alibaba Cloud OSS), and OBS (Huawei Cloud OBS).
BucketName No String Data source bucket name. Specify at least one of the bucket name or address.
BucketRegion No String Data source bucket region
BucketAddress No String Data source bucket address. Specify at least one of the bucket name or address.
ListAddress No String List address. This parameter is required if MigrationType is set to 1 (list).
FsName No String Target file system name
BucketPath No String Source bucket path, which defaults to /

3. Output Parameters

Parameter Name Type Description
TaskId String Migration task ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a migration task

This example shows you how to create a data migration task.

Input Example

Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMigrationTask
<Common request parameters>

    "BucketRegion": "ap-nanjing",
    "SrcService": "COS",
    "CoverType": "1",
    "SrcSecretKey": "*****************************",
    "BucketPath": "cos/",
    "MigrationMode": "0",
    "FileSystemId": "cfs-8dd58fd7",
    "BucketName": "test-1-1256238147",
    "FsPath": "/test/",
    "MigrationType": "0",
    "TaskName": "test",
    "SrcSecretId": "**************************************************",
    "FsName": "test"

Output Example

    "Response": {
        "TaskId": "cfsmigrate-dfe9b1f2",
        "RequestId": "91cd4a08-a105-4c59-b229-82f0fs7363b8"

5. Developer Resources


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

Command Line Interface

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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support