获取迁移任务列表

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

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMigrationTasks。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 分页的偏移量,默认值为0。
示例值:0
Limit Integer 分页单页限制数目,默认值为20,最大值100。
示例值:20
Filters.N Array of Filter
  • taskId

    按照【迁移任务id】进行过滤。
    类型:String

    必选:否


  • taskName

    按照【迁移任务名字】进行模糊搜索过滤。
    类型:String

    必选:否

    每次请求的Filters的上限为10,Filter.Values的上限为100。
  • 3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 迁移任务的数量
    示例值:0
    MigrationTasks Array of MigrationTaskInfo 迁移任务详情
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取迁移任务列表

    用于获取迁移任务列表

    输入示例

    POST / HTTP/1.1
    Host: cfs.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeMigrationTasks
    <公共请求参数>
    
    {
        "Limit": 20,
        "Offset": 0
    }

    输出示例

    {
        "Response": {
            "MigrationTasks": [
                {
                    "TaskName": "taskName",
                    "TaskId": "cfsmigrate-29d43e98",
                    "MigrationType": 0,
                    "MigrationMode": 0,
                    "BucketName": "bucket-1",
                    "BucketRegion": "oss-cn-beijing",
                    "BucketAddress": "https://test-1.oss-cn-beijing.aliyuncs.com",
                    "BucketPath": "",
                    "ListAddress": "",
                    "FsName": "t1",
                    "FileSystemId": "cfs-qz5c44o1",
                    "FsPath": "/ahh",
                    "CoverType": 0,
                    "Status": 6,
                    "FileTotalCount": 0,
                    "FileMigratedCount": 0,
                    "FileFailedCount": 0,
                    "FileTotalSize": 0,
                    "FileMigratedSize": 0,
                    "FileFailedSize": 0,
                    "FileTotalList": null,
                    "FileCompletedList": null,
                    "FileFailedList": null,
                    "CreateTime": 1662023240000,
                    "EndTime": 1662023548000
                }
            ],
            "TotalCount": 2,
            "RequestId": "c0f7c5d9-c8c4-401a-a6da-2106f3c6db76"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

    该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码