tencent cloud

文件存储

动态与公告
产品动态
产品公告
产品简介
产品概述
产品优势
存储类型及性能规格
使用场景
推荐地域
系统限制
购买指南
计费概述
价格总览
通用系列计费方式
Turbo 系列计费方式
吞吐型计费方式
快照计费方式
低频计费方式
资源单位包
资源购买
查看账单
欠费说明
快速入门
创建文件系统及挂载点
在Linux 客户端上使用 CFS 文件系统
在 Windows 客户端上使用 CFS 文件系统
在 Linux 客户端上使用 CFS Turbo 文件系统
使用 CFS 客户端助手挂载文件系统
操作指南
访问管理
管理文件系统
权限管理
使用标签
快照管理
跨可用区、跨网络访问指引
自动挂载文件系统
数据迁移服务
用户权限管理
用户配额
数据加密
数据生命周期管理
升级通用标准型文件系统
实践教程
NFS 客户端内核选择
Turbo 目录管理
计算实例销毁
在容器 TKE 上使用 CFS
在云函数 SCF上使用 CFS
在容器 TKE 上使用 CFS Turbo
在 Serverless 容器服务上使用 CFS Turbo
Turbo 文件系统网络选择
文件存储数据拷贝方案
文件存储性能测试
API 文档
History
Introduction
API Category
Snapshot APIs
File system APIs
Lifecycle APIs
Other APIs
Data Flow APIs
Making API Requests
Permission Group APIs
Service APIs
Scaling APIs
Data Migration APIs
Data Types
Error Codes
故障处理
小文件及高并发场景下客户端使用卡顿
常见问题
服务等级协议
联系我们
词汇表

CreateMigrationTask

PDF
聚焦模式
字号
最后更新时间: 2026-03-24 17:02:29

1. API Description

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

This API is used to create a migration task.

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 Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
TaskName Yes String Migration task name
MigrationType Yes Integer Migration method flags, default is 0. 0: bucket migration; 1: inventory migration.
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, which can be obtained by querying the file system through the DescribeCfsFileSystems api.
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 providers. COS: tencent cloud COS, OSS: alibaba cloud OSS, OBS: huawei cloud OBS.
BucketName No String Data source bucket name. specifies the bucket name for migration. either BucketName or BucketAddress is required for bucket migration. this parameter is not required for inventory migration.
BucketRegion No String Data source bucket region
BucketAddress No String Source bucket address. specifies the bucket address of the data source. for bucket migration, either BucketName or BucketAddress is required. this parameter is not required for inventory migration.
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, defaults to /.
Direction No Integer Migration direction. valid values: 0 (cos migration to file system), 1 (file system migration to cos). default is 0.

3. Output Parameters

Parameter Name Type Description
TaskId String Migration 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 Creating a Migration Task

Used to create a data migration task

Input Example

POST / HTTP/1.1
Host: cfs.intl.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": "migrate1",
    "SrcSecretId": "**************************************************",
    "FsName": "oldfs"
}

Output Example

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

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

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.
InternalError Internal error.
InvalidParameterValue The parameter value is incorrect.
ResourceInUse The resource is in use.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈