文档首页> 数据复制服务 DRS> API参考> API> 公共接口管理> 批量结束任务或删除任务
更新时间:2022-04-18 GMT+08:00
分享

批量结束任务或删除任务

功能介绍

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

调试

您可以在API Explorer中调试该接口。

接口约束

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project 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 DeleteJobReq objects

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

表4 DeleteJobReq

参数

是否必选

参数类型

描述

delete_type

String

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

取值:

  • terminate
  • force_terminate
  • delete

job_id

String

任务ID。

响应参数

状态码: 202

表5 响应Body参数

参数

参数类型

描述

results

Array of DeleteJobResp objects

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

count

Integer

总数。

表6 DeleteJobResp

参数

参数类型

描述

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"
      } ]
    }

响应示例

状态码: 202

Accepted

  • 示例 1:
    {
      "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."
      } ]
    }
  • 示例 2:
    {
      "count" : 1,
      "results" : [ {
        "id" : "140b5236-88ad-43c8-811c-1268453jb101",
        "status" : "success"
      } ]
    }

状态码

状态码

描述

202

Accepted

400

Bad Request

错误码

请参见错误码

分享:

    相关文档

    相关产品

close