更新时间:2023-11-22 GMT+08:00
分享

批量结束任务或删除任务

功能介绍

批量结束任务或删除实时迁移、实时同步、实时灾备任务。

对于包年/包月的任务,任务启动之后,您需要先进行订单退订,然后调该接口删除任务,退订详细操作请参见退订包周期任务

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

接口约束

  • CREATE_FAILED(创建失败)、RELEASE_RESOURCE_COMPLETE(已结束)和RELEASE_CHILD_TRANSFER_COMPLETE(子任务已结束)状态的任务才能删除,其他状态需要先结束任务,再进行删除。
  • 双主灾备时,父任务才能调用。

URI

DELETE /v3/{project_id}/jobs/batch-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

指定类型为application/json。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

X-Language

String

请求语言类型。

缺省值:en-us

取值:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

jobs

Array of objects

批量结束与删除任务请求列表。

详情请参见表4

表4 jobs字段数据结构说明

参数

是否必选

参数类型

描述

delete_type

String

terminate:结束迁移任务,force_terminate:强制结束迁移任务,delete:删除迁移任务。

取值:

  • terminate
  • force_terminate
  • delete
    说明:

    包年/包月任务需要先手动退订,然后delete_type参数设置为delete调用该接口删除任务。

job_id

String

任务ID。

is_show_breakpoint_position

Boolean

MySQL为源的实时迁移、实时同步、实时灾备任务,结束任务时是否展示断点信息。缺省为null,表示不展示断点信息。

响应参数

状态码: 202

表5 响应Body参数

参数

参数类型

描述

results

Array of objects

批量结束任务或删除任务的响应体集合。

详情请参见表6

count

Integer

总数。

表6 results字段数据结构说明

参数

参数类型

描述

id

String

任务ID。

status

String

状态。取值:

  • success
  • failed

error_code

String

错误码。

error_msg

String

错误信息。

请求示例

  • 结束指定的两个任务
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-jobs
    
    {
      "jobs" : [ {
        "delete_type" : "terminate",
        "job_id" : "4c6ac8c0-2f51-426a-97b2-cb2c668jb201"
      }, {
        "delete_type" : "terminate",
        "job_id" : "6211d20d-0006-41da-836e-db3301ajb20b"
      } ]
    }
  • 删除指定任务
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-jobs
    
    {
      "jobs" : [ {
        "delete_type" : "delete",
        "job_id" : "140b5236-88ad-43c8-811c-1268453jb101"
      } ]
    }
  • 结束任务时展示断点信息请求示例:
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-jobs 
      
     { 
       "jobs" : [{ 
         "delete_type" : "terminate", 
         "job_id" : "6211d20d-0006-41da-836e-db3301ajb20b", 
         "is_show_breakpoint_position" : true 
       } ] 
     }

响应示例

状态码: 202

Accepted

  • 结束任务响应示例
    {
      "count" : 2,
      "results" : [ {
        "id" : "4c6ac8c0-2f51-426a-97b2-cb2c668jb201",
        "status" : "success"
      }, {
        "id" : "6211d20d-0006-41da-836e-db3301ajb20b",
        "status" : "failed",
        "error_code" : "DRS.M01504",
        "error_msg" : "Another operation is being performed on the migration task or the migration task is abnormal. Try again later."
      } ]
    }
  • 删除任务响应示例
    {
      "count" : 1,
      "results" : [ {
        "id" : "140b5236-88ad-43c8-811c-1268453jb101",
        "status" : "success"
      } ]
    }

状态码

状态码

描述

202

Accepted

400

Bad Request

错误码

请参见错误码

相关文档