取消子任务 | OceanBase 文档中心

取消子任务

更新时间：2023-08-10 11:45:58

功能说明

取消执行中子任务的执行，并且将子任务标记成失败。

调用说明

接口约束

调用者需要具备 TASK_MANAGER 权限。

请求路径

POST /api/v2/tasks/instances/{taskInstanceId}/subtasks/{subtaskInstanceId}/cancel

请求参数

参数	类型	必选	示例值	描述
taskInstanceId	Long	是	1000	任务实例 ID
subtaskInstanceId	Long	是	10001	子任务实例 ID

返回结果

参数	类型	说明
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace Id，用于排查问题。
server	String	响应请求的应用服务的地址。

示例

请求示例

POST api/v2/tasks/instances/100/subtasks/1000/cancel

返回示例

{
  "duration": 55,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-08-25T15:10:13.176+08:00",
  "traceId": "0bc49000675d41af"
}