更新时间:2026-04-30 GMT+08:00
分享

批量删除作业-BatchDeleteJob

功能介绍

批量删除作业

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    octopus:dataJob:delete

    Write

    workspace *

    -

    -

    -

URI

DELETE /v1.0/{project_id}/data/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

ids

是

Array of longs

参数解释:

要删除的作业ID列表,以逗号分隔

约束限制:

最多50个ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

否

String

参数解释:

内容类型。填application/json

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

payload

DataJobBatchOperationCommonResoponse object

参数解释:

实际返回信息

meta_info

RespMetaInfo object

参数解释:

元数据

表5 DataJobBatchOperationCommonResoponse

参数

参数类型

描述

list

Array of DataJobBatchDeleteResponse objects

参数解释:

返回结果列表

表6 DataJobBatchDeleteResponse

参数

参数类型

描述

id

Long

参数解释:

作业ID

取值范围:

不涉及

result

String

参数解释:

结果

取值范围:

  • SUCCESS:成功

  • FAILED:失败

error_msg

String

参数解释:

错误原因

取值范围:

不涉及

表7 RespMetaInfo

参数

参数类型

描述

current_time

String

参数解释:

请求时间,UTC时间格式,时间为UTC标准时间

取值范围:

不涉及

请求示例

批量删除作业

DELETE https://{endpoint}/v1.0/{project_id}/data/jobs?ids=1,2,3

响应示例

状态码:200

删除成功

{
  "meta_info" : {
    "current_time" : "2022-01-01T08:08:29Z"
  },
  "payload" : {
    "list" : [ {
      "id" : 1,
      "result" : "SUCCESS"
    }, {
      "id" : 2,
      "result" : "SUCCESS"
    }, {
      "id" : 3,
      "result" : "FAILED",
      "error_msg" : "The job precondition unsatisfied."
    } ]
  }
}

状态码

状态码

描述

200

删除成功

400

请求参数错误

403

权限校验失败

404

找不到请求的资源

500

系统内部错误

错误码

请参见错误码。

相关文档