接口约束
● SUCCESS status String 实例运行状态。
5.6 数据迁移
5.6.1 创建数据迁移任务
功能介绍
创建数据迁移任务。
调试
您可以在API Explorer中调试该接口，并获取该接口关联的CLI示例： hcloud DCS CreateMigrationTask。
URI
POST /v2/{project_id}/migration-task 表5-132 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
请求参数
表5-133 请求 Body 参数
参数 是否必选 参数类型 描述
task_name 是 String 迁移任务名称。
description 否 String 迁移任务描述。
migration_typ
e 是 String 迁移任务类型,包括备份文件导
入和在线迁移两种类型。 取值 范围：
● backupfile_import：表示备 份文件导入
● online_migration：表示在线 迁移。
枚举值：
● backupfile_import
● online_migration
参数 是否必选 参数类型 描述 migration_me
thod 是 String 迁移方式，包括全量迁移和增量
迁移两种类型。 取值范围：
● full_amount_migration：表 示全量迁移。
● incremental_migration：表 示增量迁移。
枚举值：
● full_amount_migration
● incremental_migration backup_files 否 BackupFilesB
ody object 迁移任务类型为备份文件导入场
景时的备份文件列表。
network_type 否 String 迁移任务类型为在线迁移时，表 示源Redis和目标Redis联通的网
ce 否 SourceInstan
ceBody object 迁移任务类型为在线迁移场景时 该参数为必填参数，表示源 Redis信息。
target_instanc
e 是 TargetInstan
ceBody object 表示目标Redis信息。
表5-134 BackupFilesBody
参数 是否必选 参数类型 描述
file_source 否 String 数据来源，包含OBS桶和备份记 录两种类型。
枚举值：
● self_build_obs
● backup_record bucket_name 是 String OBS桶名。
files 是 Array of Files
objects 导入的备份文件文件列表，数据 来源为OBS桶时必须填写。
backup_id 否 String 备份记录ID，数据来源为备份记 录时必须填写
表5-135 Files
参数 是否必选 参数类型 描述
file_name 是 String 备份文件名。
size 否 String 文件大小（单位：Byte）。
update_at 否 String 文件最后修改时间（格式YYYY-MM-DD HH:MM:SS）。
表5-136 SourceInstanceBody
参数 是否必选 参数类型 描述
addrs 是 String Redis实例名称(source_instance 信息中填写)。
password 否 String Redis密码，如果设置了密码，
则必须填写。
表5-137 TargetInstanceBody
参数 是否必选 参数类型 描述
id 是 String Redis实例ID（target_instance 信息中必须填写）。
name 否 String Redis实例名称(target_instance 信息中填写)。
password 否 String Redis密码，如果设置了密码，
则必须填写。
响应参数
状态码： 200
表5-138 响应 Body 参数
参数 参数类型 描述
id String 迁移任务ID。
name String 迁移任务名称。
参数 参数类型 描述
status String 迁移任务状态，这个字段的值包括：SUCCESS, FAILED, MIGRATING，TERMINATED
枚举值：
● SUCCESS
● FAILED
● MIGRATING
● TERMINATED
状态码： 400
表5-139 响应 Body 参数
参数 参数类型 描述
error_msg String 错误信息
最大长度：1024 error_code String 错误码
最大长度：9
error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024
状态码： 401
表5-140 响应 Body 参数
参数 参数类型 描述
error_msg String 错误信息
最大长度：1024 error_code String 错误码
最大长度：9
error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024
状态码： 403
表5-141 响应 Body 参数
参数 参数类型 描述
error_msg String 错误信息
最大长度：1024 error_code String 错误码
最大长度：9
error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024
状态码： 404
表5-142 响应 Body 参数
参数 参数类型 描述
error_msg String 错误信息
最大长度：1024 error_code String 错误码
最大长度：9
error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024
状态码： 500
表5-143 响应 Body 参数
参数 参数类型 描述
error_msg String 错误信息
最大长度：1024 error_code String 错误码
最大长度：9
error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024
请求示例
POST https://{dcs_endpoint}/v2/{project_id}/migration-task {
"task_name" : "migration1", "description" : "Test",
"migration_type" : "online_migration",
"migration_method" : "full_amount_migration", "network_type" : "vpc",
"source_instance" : {
"addrs" : "192.168.1.135:6379", "password" : "xxxxxx"
}, "target_instance" : { "name" : "dcs-test",
"id" : "4cd5dbb8-aacd-4603-b817-3e97d48c7a20"
}}
响应示例
状态码： 200
创建数据迁移任务成功。
{ "id" : "8aa6999e71cb638b0171f485f5266ef0", "name" : "dcs-test",
"status" : "MIGRATING"
}
状态码
状态码 描述
200 创建数据迁移任务成功。
400 非法请求
401 认证信息非法
403 请求被拒绝访问。
404 所请求的资源不存在。
500 内部服务错误
错误码
请参见错误码。