文档首页/分布式缓存服务 DCS/API参考（吉隆坡区域）/API V2（推荐）/数据迁移/查询迁移任务列表
更新时间：2025-11-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询迁移任务列表

功能介绍

查询迁移任务列表。

URI

GET /v2/{project_id}/migration-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量，表示生成的列表从此偏移量开始显示，例如偏移量为3时，生成的列表从第4条开始。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

否

Integer

参数解释：

每页显示的条目数量。

约束限制：

不涉及。

取值范围：

1-1000

默认取值：

10

name

否

String

参数解释：

迁移任务名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

count

Integer

参数解释：

迁移任务数量。

取值范围：

不涉及。

migration_tasks

Array of MigrationTaskList objects

参数解释：

迁移任务列表。

取值范围：

不涉及。

表4 MigrationTaskList

参数

参数类型

描述

task_id

String

参数解释：

迁移任务ID。

取值范围：

不涉及。

task_name

String

参数解释：

迁移任务名称。

取值范围：

不涉及。

status

String

参数解释：

迁移任务状态。

取值范围：

  • SUCCESS：成功。

  • FAILED：失败。

  • MIGRATING：迁移中。

  • TERMINATED：已结束。

migration_type

String

参数解释：

迁移任务类型。

取值范围：

  • backupfile_import：备份文件导入。

  • online_migration：在线迁移。

migration_method

String

参数解释：

迁移方式。

取值范围：

  • full_amount_migration：全量迁移。

  • incremental_migration：增量迁移。

ecs_tenant_private_ip

String

参数解释：

迁移机租户侧私有IP，与目的/源redis私有IP处于同VPC，可将此IP加入白名单。

取值范围：

不涉及。

data_source

String

参数解释：

源redis地址，格式为ip:port或者桶名。

取值范围：

不涉及。

source_instance_name

String

参数解释：

源实例名称，若源实例为自建redis，该参数为空。

取值范围：

不涉及。

source_instance_id

String

参数解释：

源实例ID，若源实例为自建redis，该参数为空。

取值范围：

不涉及。

target_instance_addrs

String

参数解释：

目标redis地址，格式为ip:port。

取值范围：

不涉及。

target_instance_name

String

参数解释：

目标实例名称。

取值范围：

不涉及。

target_instance_id

String

参数解释：

目标实例ID。

取值范围：

不涉及。

created_at

String

参数解释：

迁移任务创建时间。

取值范围：

不涉及。

description

String

参数解释：

迁移任务描述。

取值范围：

不涉及。

source_instance_status

String

参数解释：

源实例状态，若源实例为自建redis，该参数为空。

取值范围：

不涉及。

target_instance_status

String

参数解释：

目标实例状态。

取值范围：

不涉及。

source_instance_subnet_id

String

参数解释：

源实例子网ID，若源实例为自建redis，该参数为空。

取值范围：

不涉及。

target_instance_subnet_id

String

参数解释：

目标实例子网ID。

取值范围：

不涉及。

source_instance_spec_code

String

参数解释：

源实例规格编码，若源实例为自建redis，该参数为空。

取值范围：

不涉及。

target_instance_spec_code

String

参数解释：

目标实例规格编码。

取值范围：

不涉及。

error_message

String

参数解释：

错误信息。

取值范围：

不涉及。

released_at

String

参数解释：

迁移机释放时间。

取值范围：

不涉及。

version

String

参数解释：

迁移任务版本。

取值范围：

不涉及。

resume_mode

String

参数解释：

迁移任务的重连模式。

取值范围：

  • auto：自动重连。

  • manual：手动重连。

supported_features

Array of strings

参数解释：

支持的特性。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

请求示例

GET https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-tasks?offset=0&limit=10&name=dcs-migration-i9qk

响应示例

状态码：200

查询迁移任务列表。

{
  "count" : 1,
  "migration_tasks" : [ {
    "task_id" : "2944a563-6f27-4604-9c16-a9a53cd95cc7",
    "task_name" : "dcs-migration-test-6-16",
    "status" : "TERMINATED",
    "migration_type" : "online_migration",
    "migration_method" : "incremental_migration",
    "data_source" : "192.168.0.200:6379",
    "source_instance_name" : "migration-resource",
    "source_instance_id" : "132e0017-715b-4556-930a-95c7db7e8f7a",
    "target_instance_addrs" : "192.168.0.153:6379",
    "target_instance_name" : "migration-target",
    "target_instance_id" : "eb1a8d1c-9ea6-4fcd-ac43-c3d3c2493f06",
    "created_at" : "2021-06-16T06:12:55.508Z",
    "description" : "dcs-test",
    "source_instance_status" : "RUNNING",
    "target_instance_status" : "RUNNING",
    "source_instance_subnet_id" : "192.168.0.1",
    "target_instance_subnet_id" : "192.168.0.2",
    "source_instance_spec_code" : "redis.single.xu1.tiny.128",
    "target_instance_spec_code" : "redis.single.xu1.tiny.128",
    "error_message" : null,
    "released_at" : "202404011057",
    "version" : "6.0.21",
    "resume_mode" : "auto",
    "supported_features" : [ ]
  } ]
}

状态码

状态码

描述

200

查询迁移任务列表。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题：数据迁移