跳转到主要内容
管理异步任务

管理异步任务:取消异步任务

取消异步任务的请求参数、响应和代码示例。

POST
/api/v1/tasks/{task_id}/cancel
cURL
curl -X POST 'https://maas.qianwenaiapi.com/api/v1/tasks/73205176-xxxx-xxxx-xxxx-16bd5d902219/cancel' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"
{
  "request_id": "45ac7f13-xxxx-xxxx-xxxx-e03c35068d83",
  "output": {
    "task_id": "73205176-xxxx-xxxx-xxxx-16bd5d902219",
    "task_status": "SUCCEEDED",
    "submit_time": "2023-12-20 21:36:31.896",
    "scheduled_time": "2023-12-20 21:36:39.009",
    "end_time": "2023-12-20 21:36:45.913",
    "results": [
      {
        "url": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxx1.png"
      },
      {
        "url": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxx2.png"
      },
      {
        "url": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxx3.png"
      },
      {
        "code": "DataInspectionFailed",
        "message": "Output data may contain inappropriate content."
      }
    ],
    "task_metrics": {
      "TOTAL": 4,
      "SUCCEEDED": 3,
      "FAILED": 1
    }
  },
  "usage": {
    "image_count": 3
  }
}
完整调用流程、参数说明和示例见管理异步任务。

鉴权

string
header
必填

路径参数

string
必填

待取消的任务 task_id。使用提交任务返回的 task_id。

响应

200-application/json
string

本次请求的唯一标识。

本次请求的系统唯一码

object

成功时包含任务结果,失败时包含错误码和错误信息。对于包含多个子任务的请求,可能同时包含结果和错误信息。

  • 任务成功时,output 包含模型生成的结果对象,具体内容因任务类型而异

  • 任务失败或部分失败时,output 会返回对应的 code 和 message,说明失败原因

  • 对于包含多个子任务的任务,output 可能同时包含成功的子任务结果和失败的错误信息

object

本次请求的计费信息,因任务类型而异。

本次请求产生的计量信息,根据实际任务的不同,相关的计量信息也有所不同

string

错误码,仅在失败时返回。

调用失败的时候返回的错误码

string

错误信息,仅在失败时返回。

调用失败的时候返回的错误信息