本文档介绍查询异步任务结果GetAsyncJobResult的语法及示例。

功能描述

针对异步接口,调用API接口后,返回的并不是真正的请求结果,您需要保存返回结果中的RequestId,然后调用GetAsyncJobResult来获取真正的请求结果。

以下为异步接口,均需要调用GetAsyncJobResult来获取真实的请求结果。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetAsyncJobResult

要执行的操作。取值:GetAsyncJobResult。

JobId String 11A898F7-29D7-4AB3-B639-8BBDE671BBD5

异步接口返回的RequestId,输入后可以查询异步接口的真实请求结果。

返回数据

名称 类型 示例值 描述
Data Struct

返回的结果数据内容。

ErrorCode String InvalidParameter

异步任务错误码。

ErrorMessage String paramsIllegal

异步任务错误码信息。

JobId String 7435839A-5B92-4AA1-B2DE-5B6C98C04DDE

异步任务Id。

Result String http://viapi-cn-shanghai-dha-filter.oss-cn-shanghai.aliyuncs.com/upload/recoloring-hd-2020-06-22-19-39-25-798c9cb57f-v6pj4/2020-6-23/invi_filter_015928997797691000043_tIPX7W.jpg?Expires=1592901579&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=qelgcQJBnzRogPybEPDDrDIjHd****

异步任务返回的真实请求结果。

Status String PROCESS_SUCCESS

异步任务状态。包括:

  • QUEUING:任务排队中
  • PROCESSING:异步处理中
  • PROCESS_SUCCESS:处理成功
  • PROCESS_FAILED:处理失败
  • TIMEOUT_FAILED:任务超时未处理完成
  • LIMIT_RETRY_FAILED:超过最大重试次数
RequestId String 6B4B827E-1CAA-43CD-BBDF-BB572E035976

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=GetAsyncJobResult
&JobId=11A898F7-29D7-4AB3-B639-8BBDE671BBD5
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>6B4B827E-1CAA-43CD-BBDF-BB572E035976</RequestId>
<Data>
    <Status>PROCESS_SUCCESS</Status>
    <JobId>7435839A-5B92-4AA1-B2DE-5B6C98C04DDE</JobId>
    <Result>{"ImageList":["http://viapi-cn-shanghai-dha-filter.oss-cn-shanghai.aliyuncs.com/upload/recoloring-hd-2020-06-22-19-39-25-798c9cb57f-v6pj4/2020-6-23/invi_filter_015928997797691000043_tIPX7W.jpg?Expires=1592901579&amp;OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&amp;Signature=qelgcQJBnzRogPybEPDDrDIjHd****"]}</Result>
</Data>

JSON 格式

{
  "RequestId": "6B4B827E-1CAA-43CD-BBDF-BB572E035976",
  "Data": {
    "Status": "PROCESS_SUCCESS",
    "JobId": "7435839A-5B92-4AA1-B2DE-5B6C98C04DDE",
    "Result": "{\"ImageList\":[\"http://viapi-cn-shanghai-dha-filter.oss-cn-shanghai.aliyuncs.com/upload/recoloring-hd-2020-06-22-19-39-25-798c9cb57f-v6pj4/2020-6-23/invi_filter_015928997797691000043_tIPX7W.jpg?Expires=1592901579&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=qelgcQJBnzRogPybEPDDrDIjHd****\"]}"
  }
}

错误码

关于查询异步任务结果的错误码,详情请参见常见错误码

SDK参考

单击SDK简介查看SDK信息。