停止数据迁移任务
功能介绍
停止数据迁移任务。
URI
POST /v2/{project_id}/migration-task/{task_id}/stop
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
task_id |
是 |
String |
任务ID |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
迁移任务ID。 |
task_name |
String |
迁移任务名称。 |
description |
String |
迁移任务描述。 |
status |
String |
迁移任务状态,这个字段的值包括:SUCCESS(成功), FAILED(失败), MIGRATING(迁移中),TERMINATED(已结束),TERMINATING(停止中),INCRMIGEATING(增量迁移中),FULLMIGRATING(全量迁移中),RUNNING(待配置),MIGRATION_FAILED(迁移失败),RELEASED(已释放)。 枚举值:
|
migration_type |
String |
迁移任务类型,包括备份文件导入和在线迁移两种类型。 枚举值:
|
migration_method |
String |
迁移方式,包括全量迁移和增量迁移两种类型。 枚举值:
|
ecs_tenant_private_ip |
String |
迁移机租户侧私有IP,与目的/源redis私有IP处于同VPC,可将此IP加入白名单。 |
backup_files |
BackupFilesBody object |
备份文件导入场景的备份文件列表。 |
network_type |
String |
网络类型,包括vpc和vpn两种类型。 枚举值:
|
source_instance |
SourceInstanceBody object |
源Redis信息。在线迁移场景需要填写。 |
target_instance |
TargetInstanceBody object |
目标Redis信息。 |
created_at |
String |
迁移任务创建时间。 |
updated_at |
String |
迁移任务完成时间。 |
released_at |
String |
迁移机释放时间。 |
version |
String |
版本。 |
resume_mode |
String |
操作模式,分为auto和manual。 |
supported_features |
Array of strings |
支持的特性。 |
tenant_vpc_id |
String |
租户VPC ID。 |
tenant_subnet_id |
String |
租户子网ID。 |
tenant_security_group_id |
String |
租户安全组ID。 |
bandwidth_limit_mb |
String |
带宽限制速度。 |
task_status |
String |
任务状态,只有在交换IP时会返回EXCHANGING。 |
参数 |
参数类型 |
描述 |
---|---|---|
file_source |
String |
数据来源,包含OBS桶和备份记录两种类型。 枚举值:
|
bucket_name |
String |
OBS桶名。 |
files |
Array of Files objects |
导入的备份文件文件列表,数据来源为OBS桶时必须填写。 |
backup_id |
String |
备份记录ID,数据来源为备份记录时必须填写。 |
参数 |
参数类型 |
描述 |
---|---|---|
file_name |
String |
备份文件名。 |
size |
String |
文件大小(单位:Byte)。 |
update_at |
String |
文件最后修改时间(格式YYYY-MM-DD HH:MM:SS)。 |
参数 |
参数类型 |
描述 |
---|---|---|
addrs |
String |
Redis实例地址(source_instance信息中填写)。 |
password |
String |
Redis密码,如果设置了密码,则必须填写。 |
task_status |
String |
任务状态。 |
id |
String |
Redis实例ID。 |
ip |
String |
Redis IP地址。 |
port |
String |
Redis端口。 |
name |
String |
Redis名称。 |
proxy_multi_db |
Boolean |
proxy实例是否开启了多DB。 |
db |
String |
Redis数据库。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
Redis实例ID(target_instance信息中必须填写)。 |
name |
String |
Redis实例名称(target_instance信息中填写)。 |
password |
String |
Redis密码,如果设置了密码,则必须填写。 |
task_status |
String |
任务状态。 |
ip |
String |
Redis IP地址。 |
port |
String |
Redis端口。 |
addrs |
String |
Redis实例地址。 |
proxy_multi_db |
Boolean |
proxy实例是否开启了多DB。 |
db |
String |
Redis数据库。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 |
请求示例
POST https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-task/2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca/stop
响应示例
状态码: 200
停止数据迁移任务成功。
{ "task_name" : "migration1", "task_id" : "a276c1ffa0a54c2597fc824b917db317", "status" : "TERMINATING", "migration_type" : "incremental_migration", "network_type" : "vpc", "source_instance" : { "addrs" : "192.168.1.2:6379", "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927e1", "name" : "dcs-test", "ip" : "192.168.1.2", "port" : "6379", "proxy_multi_db" : false, "password" : "DCStest123", "task_status" : "RUNNING", "db" : "0" }, "target_instance" : { "addrs" : "192.168.1.2:6379", "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927ee", "name" : "test-instance", "ip" : "192.168.1.2", "port" : "6379", "proxy_multi_db" : false, "password" : "DCStest123", "task_status" : "RUNNING", "db" : "0" }, "created_at" : "2019/10/22 14:44:30", "updated_at" : "2019/10/22 18:00:00" }
状态码
状态码 |
描述 |
---|---|
200 |
停止数据迁移任务成功。 |
400 |
非法请求。 |
401 |
认证信息非法。 |
403 |
请求被拒绝访问。 |
404 |
所请求的资源不存在。 |
500 |
内部服务错误。 |
错误码
请参见错误码。