关闭文件处理 API

❖ 功能说明

取消尚未完成的异步文件处理任务。

取消异步任务

POSThttp://localhost:8080/api/v1/task/{id}/cancel

❖ 请求参数 (Parameters)

x-api-key*

在 Header 中发送的 x-api-key 认证凭证，请登录 Dashboard 的 API 管理页面查看当前部署的 API Access Key。

Path Parameters

idstring*

任务 ID。

❖ 响应属性说明

字段	类型	说明
code	Integer	业务状态码。
msg	String	响应消息。
data	Object	响应数据。
data.taskId	String
data.status	String
data.failureCode	String	文件转换失败时的错误码。
data.failureReason	String

🔗请求示例 (Request)

curl --request POST \
  --url http://localhost:8080/api/v1/task/{id}/cancel \
  --header 'x-api-key: YOUR API-KEY'

✓响应示例 (Response)

200 OK

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "<string>",
    "status": "canceled",
    "failureCode": "TASK_CANCELED",
    "failureReason": "任务已由客户端取消"
  }
}

需要主动终止异步任务？

当异步任务已提交，但您不希望继续处理时，可以发起"关闭任务"请求主动终止该任务。

前往【关闭任务】