创建数据迁移任务
功能介绍
创建数据迁移任务。
接口约束
无
URI
POST /v2/{project_id}/migration-task
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 获取方法请参见获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_name |
是 |
String |
迁移任务名称。 |
description |
否 |
String |
迁移任务描述。 |
migration_type |
是 |
String |
迁移任务类型,包括备份文件导入和在线迁移两种类型。 取值范围:
|
migration_method |
是 |
String |
迁移方式,包括全量迁移和增量迁移两种类型。 取值范围:
|
backup_files |
否 |
BackupFilesBody Object |
迁移任务类型为备份文件导入场景时的备份文件列表。 |
network_type |
否 |
String |
迁移任务类型为在线迁移时,表示源Redis和目标Redis联通的网络类型,包括vpc和vpn两种类型。 取值范围:
|
source_instance |
否 |
SourceInstanceBody Object |
迁移任务类型为在线迁移场景时该参数为必填参数,表示源Redis信息。 |
target_instance |
是 |
TargetInstanceBody Object |
表示目标Redis信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
file_source |
否 |
String |
数据来源,当前仅支持OBS桶方式,取值为:self_build_obs。 |
bucket_name |
是 |
String |
OBS桶名。 |
files |
是 |
Array of Files Objects |
导入的备份文件文件列表。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
file_name |
是 |
String |
备份文件名。 |
size |
否 |
String |
文件大小(单位:Byte)。 |
update_at |
否 |
String |
文件最后修改时间(格式YYYY-MM-DD HH:MM:SS)。 |
响应参数
状态码为 200 时,返回以下参数:
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
迁移任务ID。 |
name |
String |
迁移任务名称。 |
status |
String |
迁移任务状态,这个字段的值包括:
|
请求示例
- 请求URL示例
POST https://{dcs_endpoint}/v2/{project_id}/migration-task
- 请求示例1(在线迁移方式)
{ "task_name" : "lmd-test", "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" } }
- 请求示例2(备份文件导入方式)
{ "backup_files": { "bucket_name": "bucket-lmz", "file_source": "self_build_obs", "files": [ { "file_name": "appendonly03.aof" } ] }, "migration_method": "full_amount_migration", "migration_type": "backupfile_import", "target_instance": { "id": "318ed365-3c1b-42d7-a5b6-663dded628a0" }, "task_name": "lmd-test" }
响应示例
状态码为 200 时,创建数据迁移任务成功。
{ "id" : "8aa6999e71cb638b0171f485f5266ef0", "name" : "lmd-test", "status" : "MIGRATING" }
状态码
状态码 |
描述 |
---|---|
200 |
创建数据迁移任务成功。 |
400 |
非法请求 |
500 |
内部服务错误 |
错误码
请参见错误码。