创建迁移任务

最近更新时间:2024-03-12 01:15:36

我的收藏

1. 接口描述

接口请求域名: cfs.tencentcloudapi.com 。

用于创建迁移任务。
此接口需提交工单,开启白名单之后才能使用。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateMigrationTask。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,详见产品支持的 地域列表
TaskName String 迁移任务名称
示例值:copytask
MigrationType Integer 迁移方式标志位,默认为0。0: 桶迁移;1: 清单迁移
示例值:0
MigrationMode Integer 迁移模式,默认为0。0: 全量迁移
示例值:0
SrcSecretId String 数据源账号的SecretId
示例值:12345
SrcSecretKey String 数据源账号的SecretKey
示例值:12345
FileSystemId String 文件系统实例Id
示例值:cfs-xxxxxx
FsPath String 文件系统路径
示例值:/cfs/123
CoverType Integer 同名文件迁移时覆盖策略,默认为0。0: 最后修改时间优先;1: 全覆盖;2: 不覆盖
示例值:0
SrcService String 数据源服务商。COS: 腾讯云COS,OSS: 阿里云OSS,OBS:华为云OBS
示例值:OSS
BucketName String 数据源桶名称,名称和地址至少有一个
示例值:testbucket-125xxxxxxx
BucketRegion String 数据源桶地域
示例值:ap-guangzhou
BucketAddress String 数据源桶地址,名称和地址至少有一个
示例值:https://testbucket-125xxxxxx.cos.ap-guangzhou.myqcloud.com
ListAddress String 清单地址,迁移方式为清单迁移时必填
示例值:https://testbucket-125xxxxxxx.cos.ap-guangzhou.myqcloud.com/cos_bucket_inventory/125xxxxx/brucetest/test/20240122/manifest.json
FsName String 目标文件系统名称
示例值:name
BucketPath String 源桶路径,默认为/
示例值:cos/

3. 输出参数

参数名称 类型 描述
TaskId String 迁移任务Id
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建迁移任务

用于创建数据迁移任务

输入示例

POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMigrationTask
<公共请求参数>

{
    "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"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。