跳转至

工作空间资源任务取消


POST /api/v1/workspace/resource/cancel

概述

取消工作空间资源导入导出任务

Body 请求参数

参数名 类型 必选 说明
taskId string Y 任务ID
例子: task_xxx
允许为空: False

参数补充说明

1. 接口用途

取消一个正在执行中的工作空间资源导入或导出任务。

2. 使用说明

你需要传入通过导入/导出接口获取到的 taskId。

取消请求提交成功后，接口会返回：

{
  "status": "cancel"
}

说明： - 该返回表示任务已被标记为取消 - 具体任务最终状态可继续通过任务状态接口确认

3. 注意事项

  1. 已执行完成的任务无法回退
  2. 已部分成功执行的导入任务，不会自动回滚已写入的数据
  3. 如果需要确认取消是否生效，请继续轮询任务状态接口

请求例子

curl 'https://openapi.guance.com/api/v1/workspace/resource/cancel' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"taskId":"task_xxx"}' \
--compressed

响应

{
    "code": 200,
    "content": {
        "status": "cancel"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}

文档评价

文档内容是否对您有帮助？ ×