本文介绍查询异步任务结果GetAsyncJobResult的语法及示例。
功能描述
异步接口调用API接口后,返回的并不是真正的请求结果,您需要保存返回结果中的RequestId,然后调用GetAsyncJobResult来获取真正的请求结果。
说明
- 异步任务的文件有过期时间,有效期是30分钟。如需长期使用,需及时将文件下载到本地服务器或存储在OSS中。有关OSS更多操作信息,请参见上传文件。
- 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等,请通过钉钉群(23109592)加入阿里云视觉智能开放平台咨询群联系我们。
当前分割抠图类目中通用高清分割(SegmentHDCommonImage)为异步接口,需要调用GetAsyncJobResult来获取真实的请求结果。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetAsyncJobResult |
系统规定参数。取值:GetAsyncJobResult。 |
JobId | String | 是 | E75FE679-0303-4DD1-8252-1143B4FA8A27 |
异步接口返回的RequestId,输入后可以查询异步接口的真实请求结果。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 43A0AEB6-45F4-4138-8E89-E1A5D63200E3 |
请求ID。 |
Data | Object |
返回的结果数据内容。 |
|
Status | String | PROCESS_SUCCESS |
异步任务状态。包括:
|
ErrorMessage | String | paramsIllegal |
异步任务错误码信息。 |
Result | String | {"ImageUrl":"http://viapi-cn-shanghai-dha-segmenter.oss-cn-shanghai.aliyuncs.com/upload/result_/2020-4-2/invi__015858226731531000018_UE7B9p.png?Expires=1585824473&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSR****&Signature=etyeYQQ%2BWAyQTqQKd8Xq0GiOW****"} |
异步任务返回的真实请求结果。需要自己进行反序列化。 |
ErrorCode | String | InvalidParameter |
异步任务错误码。 |
JobId | String | 49E2CC28-ED1D-4CC5-854D-7D0AE2B20976 |
异步任务ID。 |
SDK参考
阿里云视觉AI能力推荐使用SDK调用,支持多种编程语言,文件参数通过SDK调用可支持本地文件及任意URL,具体可参见SDK总览。
示例
请求示例
http(s)://imageseg.cn-shanghai.aliyuncs.com/?Action=GetAsyncJobResult //更多关于访问域名(Endpoint)信息,请参见:https://help.aliyun.com/document_detail/143103.html
&JobId=E75FE679-0303-4DD1-8252-1143B4FA8A27
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetAsyncJobResultResponse>
<RequestId>43A0AEB6-45F4-4138-8E89-E1A5D63200E3</RequestId>
<Data>
<Status>PROCESS_SUCCESS</Status>
<JobId>186AC396-0EEC-46F1-AAA1-BF3585227427</JobId>
<Result>{"ImageUrl":"http://viapi-cn-shanghai-dha-segmenter.oss-cn-shanghai.aliyuncs.com/upload/result_/2020-4-2/invi__015858228333801000019_zs0HOi.png?Expires=1585824633&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSR*****&Signature=YHSg24oLm3yk*****%3D"}</Result>
<status>PROCESS_SUCCESS</status>
</Data>
</GetAsyncJobResultResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "43A0AEB6-45F4-4138-8E89-E1A5D63200E3",
"Data" : {
"Status" : "PROCESS_SUCCESS",
"JobId" : "186AC396-0EEC-46F1-AAA1-BF3585227427",
"Result" : "{\"ImageUrl\":\"http://viapi-cn-shanghai-dha-segmenter.oss-cn-shanghai.aliyuncs.com/upload/result_/2020-4-2/invi__015858228333801000019_zs0HOi.png?Expires=1585824633&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSR*****&Signature=YHSg24oLm3yk*****%3D\"}",
"status" : "PROCESS_SUCCESS"
}
}
Result反序列化
将上面Result反序列化展示如下。
{
"ImageUrl": "http://viapi-cn-shanghai-dha-segmenter.oss-cn-shanghai.aliyuncs.com/upload/result_/2020-4-2/invi__015858228333801000019_zs0HOi.png?Expires=1585824633&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSR*****&Signature=YHSg24oLm3yk********%3D"
}
错误码
详情请参见常见错误码。
安全声明
- 请确保上传的图片或文件来源符合相应的法律法规。
- 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。