异步结果查询接口

更新时间:
复制为 MD 格式

所有异步 API 共用同一个结果查询接口 /rest/ai/task/queryTaskResult。提交异步任务后获取 TaskId,再通过本接口轮询任务状态,直到 StatusCOMPLETEDFAILED

接口

POST /rest/ai/task/queryTaskResult

所有异步 SKU(如商品素材优化 Lite/Pro、智能出图、文档翻译、尺码图提取、件重尺审核等)通过本接口轮询结果。建议轮询间隔不低于 5 秒。

请求参数

参数名称

数据类型

是否必填

参数描述及示例值

TaskId

String

必填

异步任务提交接口返回的任务 ID。示例:b67f6089-085a-9402-93c6-bac0561b3a06

请求示例

{
    "TaskId": "b67f6089-085a-9402-93c6-bac0561b3a06"
}

响应参数

参数名称

数据类型

参数描述

Code

String

响应代码。请求成功为 "success"

Data

Object

返回的结果信息。

Data.Status

String

任务状态:QUEUED(任务刚提交在排队执行)、IN_PROGRESS(任务执行中)、COMPLETED(任务执行完成)、FAILED(任务执行失败)。

Data.TaskId

String

任务 ID(与请求参数相同)。

Data.Result

String(JSON)

任务结果,为 JSON 字符串,需二次解析(JSON.parse)。任务状态为 FAILED 时返回失败原因。具体业务字段结构因 SKU 不同,详见各 SKU 文档。

Data.UsageMap

String / Object

用量字段。Key 因 SKU 而异,如 ProcessedImageCount(图片类)、ProcessedDocumentPageCount(文档类)、ProcessingCount(请求次数类)。

RequestId

String

请求 ID,用于唯一标识一次请求调用,排查问题时联系技术支持需提供。

Success

Boolean

是否成功:true 代表成功,false 代表失败。

Message

String

报错信息。请求成功时为 "Success";失败时返回错误说明,例如"参数中包含敏感信息,请尝试其他输入"。

响应示例

成功示例(图片类,如尺码图提取)

{
  "Data": {
    "Status": "COMPLETED",
    "UsageMap": {
      "ProcessedImageCount": "1"
    },
    "TaskId": "933fa07c-89a7-9607-a1be-37feaacb0e13",
    "Result": "{\"message\": {\"Https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/.../0a914347.png\": {\"SizeChart\": [{\"尺码\": {\"value\": \"S\"}, \"腰围\": {\"unit\": \"CM\", \"value\": 58}}, {\"尺码\": {\"value\": \"M\"}, \"腰围\": {\"unit\": \"CM\", \"value\": 59}}], \"SizeChartAttributes\": [\"尺码\", \"裙长\", \"腰围(拉伸)\", \"体重建议\"], \"IntersectionAttributes\": [\"尺码\", \"腰围\"]}}}"
  },
  "RequestId": "FCF68492-7CEB-1469-9AC9-0149A1F4416E",
  "Message": "Success",
  "Code": "success",
  "Success": true
}

成功示例(文档类,如文档翻译)

{
  "Data": {
    "Status": "COMPLETED",
    "UsageMap": {
      "ProcessedDocumentPageCount": "1"
    },
    "TaskId": "cd98a77e-dfb0-98e0-ba62-615657e8359d",
    "Result": "{\"url\": \"https://aidge-bailian-oss.oss-cn-beijing.aliyuncs.com/.../translated_en.pdf?...\"}"
  },
  "RequestId": "6478F009-C44F-1FAB-BEF4-928E5DAD55B8",
  "Message": "Success",
  "Code": "success",
  "Success": true
}

失败示例

{
  "Data": {
    "Status": "FAILED",
    "TaskId": "7bcd2010-dd79-9b89-9d7f-8c256bf69456",
    "Result": "\"usageMap parse error\""
  },
  "RequestId": "9923C1E4-BACD-1C93-A642-0D4921D374C2",
  "Message": "Success",
  "Code": "success",
  "Success": true
}

注意事项

  • 任务失败仍返回 success:任务执行失败(Data.Status = FAILED)时,接口请求本身仍返回 Code: "success" + Success: true。需要通过 Data.Status 字段判断任务是否成功。

  • Result 需二次解析Data.Result 是 JSON 字符串而非原生对象,使用前必须 JSON.parse

  • 轮询节奏:建议轮询间隔 ≥ 5 秒。查询接口本身没有 QPS 限制,但提交接口的 QPS 上限因 SKU 而异,详见频率限制

  • 错误排查:失败时优先看 Data.Result(失败原因)+ RequestId。完整错误码列表参见错误码