文档首页> 分布式缓存服务 DCS> API参考（巴黎区域）> API V2（推荐）> 数据迁移> 查询迁移任务列表
更新时间：2023-12-13 GMT+08:00
查看PDF

查询迁移任务列表

功能介绍

查询迁移任务列表。

URI

GET /v2/{project_id}/migration-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询， offset大于等于0。

limit

否

Integer

每页显示的条目数量。

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（已结束）。

枚举值：

  • 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

迁移任务创建时间。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

请求示例

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

状态码

状态码

描述

200

查询迁移任务列表。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题： 数据迁移