获取数据迁移任务列表

最近更新时间:2025-06-20 02:10:44

我的收藏

1. 接口描述

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

获取数据迁移任务列表,Filter参数使用说明如下:

TaskId,根据任务ID精确查找
InstanceId,根据实例ID精确查找
Type,根据任务类型精确查找

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMigrationTaskList。
Version String 公共参数,本接口取值:2023-03-08。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 查询条件列表
Offset Integer 查询起始位置
示例值:0
Limit Integer 查询结果限制数量
示例值:20

3. 输出参数

参数名称 类型 描述
TotalCount Integer 查询总数
示例值:10
Tasks Array of MigrationTaskItem 迁移任务列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取数据迁移任务列表

输入示例

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

{
    "Filters": [],
    "Offset": 0,
    "Limit": 20
}

输出示例

{
    "Response": {
        "RequestId": "bd8c6783-04a4-419f-bc51-9af603872490",
        "TotalCount": 1,
        "Tasks": [
            {
                "TaskId": "603872-7a11-c67",
                "Type": 1,
                "InstanceId": "rmq-47zbegoa",
                "TopicNum": 4,
                "GroupNum": 0,
                "Status": 1,
                "CreateTime": 1693219938000
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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