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

配置在线数据迁移任务

功能介绍

配置在线数据迁移任务。

URI

POST /v2/{project_id}/migration/{task_id}/task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

task_id

是

String

在线迁移任务ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

migration_method

是

String

迁移方式，包括全量迁移和增量迁移两种类型。

  • 全量迁移：该模式为Redis的一次性迁移，适用于可中断业务的迁移场景。 全量迁移过程中，如果源Redis有数据更新，这部分更新数据不会被迁移到目标Redis。

  • 增量迁移：该模式为Redis的持续性迁移，适用于对业务中断敏感的迁移场景。 增量迁移阶段通过解析日志等技术， 持续保持源Redis和目标端Redis的数据一致。取值范围：

  • full_amount_migration：表示全量迁移。

  • incremental_migration：表示增量迁移。

枚举值：

  • full_amount_migration

  • incremental_migration

resume_mode

是

String

自动重连，根据参数决定是否自动重连。 自动重连模式在遇到网络等异常情况时，会无限自动重试。 自动重连模式在无法进行增量同步时，会触发全量同步，增加带宽占用，请谨慎选择。取值范围：

  • auto：自动重连。

  • manual：手动重连。

枚举值：

  • auto

  • manual

bandwidth_limit_mb

否

String

带宽限制，当迁移方式为增量迁移时，为保证业务正常运行，您可以启用带宽限制功能，当数据同步速度达到带宽限制时，将限制同步速度的继续增长。

  • 带宽限制的单位为MB/s。

  • 取值范围：1-10240（大于0小于10241之间的整数）。

source_instance

是

ConfigMigrationInstanceBody object

表示源Redis信息。

target_instance

是

ConfigMigrationInstanceBody object

表示目标Redis信息。
表3 ConfigMigrationInstanceBody

参数

是否必选

参数类型

描述

id

否

String

Redis实例ID（若不填写addrs，则必须填写ID）。

addrs

否

String

Redis实例地址（若不填写ID，则必须填写addrs）。

password

否

String

Redis密码，如果设置了密码，则必须填写。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

迁移任务ID。

name

String

迁移任务名称。

status

String

迁移任务状态，这个字段的值包括：SUCCESS（成功）, FAILED（失败）, MIGRATING（迁移中），TERMINATED（已结束）。

枚举值：

  • SUCCESS

  • FAILED

  • MIGRATING

  • TERMINATED

error

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

请求示例

配置在线迁移任务，迁移方式为增量迁移，开启自动重连，配置源端和目标端实例信息。

POST https://{dcs_endpoint}/v2/{project_id}/migration/{task_id}/task

{
  "migration_method" : "incremental_migration",
  "bandwidth_limit_mb" : 123,
  "resume_mode" : "auto",
  "source_instance" : {
    "id" : null,
    "addrs" : "192.168.1.1:6379,192.168.0.0:6379",
    "password" : "xxxxxx"
  },
  "target_instance" : {
    "id" : "cf4a05df-1c38-47c5-bb5a-0a7b3673b3bd",
    "addrs" : null,
    "password" : null
  }
}

响应示例

状态码： 200

配置在线数据迁移任务成功。

{
  "id" : "90754308-a156-406f-a837-8f852f38a646",
  "name" : "dcs-migration-1db7",
  "status" : "FULLMIGRATING",
  "error" : ""
}

状态码

状态码

描述

200

配置在线数据迁移任务成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题： 数据迁移