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

批量停止数据迁移任务

功能介绍

批量停止数据迁移任务，接口响应成功，仅表示下发任务成功。查询到迁移任务状态为TERMINATED时，即停止成功。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

migration_tasks

是

Array of strings

数据迁移任务列表。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

migration_tasks

Array of StopMigrationTaskResult objects

数据迁移任务列表。
表4 StopMigrationTaskResult

参数

参数类型

描述

result

String

下发停止迁移任务操作结果。

枚举值：

  • success

  • failed

task_id

String

数据迁移任务ID。

状态码： 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/batch-stop

{
  "migration_tasks" : [ "b21989ec-2889-4b8e-99db-19c073425ec2", "5130d57f-640a-435b-bc3a-0fb1860a5340" ]
}

响应示例

状态码： 200

批量下发停止迁移任务成功。

查询迁移任务状态为TERMINATED，即停止成功。

{
  "migration_tasks" : [ {
    "result" : "success",
    "task_id" : "b21989ec-2889-4b8e-99db-19c073425ec2"
  }, {
    "result" : "failed",
    "task_id" : "5130d57f-640a-435b-bc3a-0fb1860a5340"
  } ]
}

状态码： 400

非法请求。

{
  "error_msg" : "invalid migration task id in the request.",
  "error_code" : "DCS.4855"
}

状态码

状态码

描述

200

批量下发停止迁移任务成功。

说明：

查询迁移任务状态为TERMINATED，即停止成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题： 数据迁移