文档首页/分布式缓存服务 DCS/API参考（吉隆坡区域）/API V2（推荐）/数据迁移/停止数据迁移任务
更新时间：2025-11-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

停止数据迁移任务

功能介绍

停止数据迁移任务。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

task_id

是

String

参数解释：

数据迁移任务ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

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

参数解释：

迁移任务描述。

取值范围：

  • backupfile_import：备份导入。

  • online_migration：在线迁移。

migration_method

String

参数解释：

迁移方式。

取值范围：

  • full_amount_migration：全量迁移。

  • incremental_migration：在线迁移。

ecs_tenant_private_ip

String

参数解释：

迁移机租户侧私有IP，与目的/源redis私有IP处于同VPC，可将此IP加入白名单。

取值范围：

不涉及。

backup_files

BackupFilesRespBody object

参数解释：

备份文件导入场景的备份文件列表。

network_type

String

参数解释：

网络类型，包括vpc和vpn两种类型。

取值范围：

  • vpc

  • vpn

source_instance

SourceInstanceRespBody object

参数解释：

源Redis信息。

target_instance

TargetInstanceRespBody 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。

取值范围：

EXCHANGING: IP交换中。

表3 BackupFilesRespBody

参数

参数类型

描述

file_source

String

参数解释：

数据来源，包含OBS桶和备份记录两种类型。

取值范围：

  • self_build_obs：obs桶数据。

  • backup_record：Redis备份文件。

bucket_name

String

参数解释：

OBS桶名。

取值范围：

不涉及。

files

Array of FilesResp objects

参数解释：

导入的备份文件列表。

backup_id

String

参数解释：

备份记录ID。

取值范围：

不涉及。

表4 FilesResp

参数

参数类型

描述

file_name

String

参数解释：

备份文件名。

取值范围：

不涉及。

size

String

参数解释：

文件大小（单位：Byte）。

取值范围：

不涉及。

update_at

String

参数解释：

文件最后修改时间（格式YYYY-MM-DD HH:MM:SS）。

取值范围：

不涉及。

表5 SourceInstanceRespBody

参数

参数类型

描述

addrs

String

参数解释：

Redis实例IP和域名地址。

取值范围：

不涉及。

password

String

参数解释：

Redis密码。

取值范围：

不涉及。

id

String

参数解释：

Redis实例ID。

取值范围：

不涉及。

ip

String

参数解释：

Redis IP地址。

取值范围：

不涉及。

port

String

参数解释：

Redis端口。

取值范围：

不涉及。

name

String

参数解释：

Redis名称。

取值范围：

不涉及。

proxy_multi_db

Boolean

参数解释：

Proxy实例是否开启了多DB。

取值范围：

  • true：开启。

  • false：未开启。

db

String

参数解释：

Redis数据库。

取值范围：

0-255。

withProxy

Boolean

参数解释：

是否有Proxy节点。

取值范围：

  • true：带有Proxy节点。

  • false：不带有Proxy节点。

表6 TargetInstanceRespBody

参数

参数类型

描述

addrs

String

参数解释：

Redis实例地址（source_instance信息中填写）。

取值范围：

不涉及。

password

String

参数解释：

Redis密码。

取值范围：

不涉及。

id

String

参数解释：

Redis实例ID。

取值范围：

不涉及。

ip

String

参数解释：

Redis IP地址。

取值范围：

不涉及。

port

String

参数解释：

Redis端口。

取值范围：

不涉及。

name

String

参数解释：

Redis名称。

取值范围：

不涉及。

proxy_multi_db

Boolean

参数解释：

Proxy实例是否开启了多DB。

取值范围：

  • true：开启。

  • false：未开启。

db

String

参数解释：

Redis数据库。

取值范围：

0-255。

withProxy

Boolean

参数解释：

是否有Proxy节点。

取值范围：

  • true：带有Proxy节点。

  • false：不带有Proxy节点。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

请求示例

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",
    "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",
    "db" : "0"
  },
  "created_at" : "2019/10/22 14:44:30",
  "updated_at" : "2019/10/22 18:00:00"
}

状态码

状态码

描述

200

停止数据迁移任务成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题：数据迁移