本文介绍查询异步任务列表QueryAsyncJobList的语法及示例。

功能描述

在您成功提交异步任务以后，可以通过QueryAsyncJobList来查询已经提交的任务信息列表。

说明
  • 您可以进入在线咨询获取在线人工帮助。
  • 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。

示例代码

该能力常用语言查询异步任务列表的示例代码，请参见查询异步任务列表示例代码。

调用说明

  • 只能查询当前账号提交的异步任务。
  • 只有开通了对应能力以后才可以根据类目名称和能力接口名称进行筛选查询。
  • 当前接口调用每5秒内只允许请求1次，如果返回报错，请5秒后再次重试。
  • 无法查询时间长度超过24小时以外的数据。

调试

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

请求参数

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

系统规定参数。取值：QueryAsyncJobList。
StartTime String 否 2023-01-04 00:00:00

开始时间。
EndTime String 否 2023-01-04 23:00:00

结束时间。
JobId String 否 E75FE679-0303-4DD1-8252-1143B4FA8A27

异步接口返回的RequestId。
PopProduct String 否 ocr

类目英文名，详情可参考能力开通中的类目英文名。
PopApiName String 否 RecognizeIdentityCard

能力接口名，详情可参考能力开通中的能力接口名。
Status String 否 PROCESS_SUCCESS

异步任务状态。包括：

  • QUEUING：任务排队中
  • PROCESSING：异步处理中
  • PROCESS_SUCCESS：处理成功
  • PROCESS_FAILED：处理失败
  • TIMEOUT_FAILED：任务超时未处理完成
  • LIMIT_RETRY_FAILED：超过最大重试次数
  • JOB_CANCELED：任务取消
PageNum String 否 1

起始页。
PageSize String 否 20

每页查询条数，最大500条。

返回数据

名称 类型 示例值 描述
RequestId String 43A0AEB6-45F4-4138-8E89-E1A5D63200E3

请求ID。
Data Object

返回的数据内容。
CurrentPage Integer 1

当前页。
PageSize Integer 20

每页查询条数。
TotalPage Integer 2

总页数。
TotalRecord Integer 22

总条数。
Result Array of result

查询结果。
CallerParentId String 1850343078585779

任务提交人ID。
EndTime String 2023-01-04 17:18:44

任务结束时间。
GmtCreate String 2023-01-04 17:18:44

任务创建时间。
JobId String 49E2CC28-ED1D-4CC5-854D-7D0AE2B20976

异步任务ID。
PopApiName String DetectVideoShot

能力接口名，详情可参考能力开通中的能力接口名。
PopProduct String videorecog

类目英文名，详情可参考能力开通中的类目英文名。
StartTime String 2023-01-04 17:18:44

任务开始时间。
Status String PROCESS_SUCCESS

异步任务状态。包括：

  • QUEUING：任务排队中
  • PROCESSING：异步处理中
  • PROCESS_SUCCESS：处理成功
  • PROCESS_FAILED：处理失败
  • TIMEOUT_FAILED：任务超时未处理完成
  • LIMIT_RETRY_FAILED：超过最大重试次数
Message String paramsIllegal

异步任务错误码信息。
Success Boolean true

是否调用成功，取值true或false。
HttpCode String InvalidParameter

异步任务错误码。

SDK参考

阿里云视觉AI能力推荐使用SDK调用，支持多种编程语言，具体可参见SDK总览。

示例

请求示例

http(s)://viapi.cn-shanghai.aliyuncs.com/?action=QueryAsyncJobList //更多关于访问域名（Endpoint）信息，请参见：https://help.aliyun.com/document_detail/143103.html
&callerParentId=1850343078585779 
&startTime=2023-01-04 17:18:44
&endTime=2023-01-04 17:18:44
&jobId=49E2CC28-ED1D-4CC5-854D-7D0AE2B20976
&popProduct=videorecog
&popApiName=DetectVideoShot
&status=PROCESS_SUCCESS
&gmtCreate=2023-01-04 17:18:44      
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryAsyncJobListResponse>
    <RequestId>43A0AEB6-45F4-4138-8E89-E1A5D63200E3</RequestId>
    <Data>
        <CurrentPage>1</CurrentPage>
        <PageSize>20</PageSize>
        <TotalPage>2</TotalPage>
        <TotalRecord>22</TotalRecord>
        <Result>
            <CallerParentId>1850343078585779</CallerParentId>
            <EndTime>2023-01-04 17:18:44</EndTime>
            <GmtCreate>2023-01-04 17:18:44</GmtCreate>
            <JobId>49E2CC28-ED1D-4CC5-854D-7D0AE2B20976</JobId>
            <PopApiName>DetectVideoShot</PopApiName>
            <PopProduct>videorecog</PopProduct>
            <StartTime>2023-01-04 17:18:44</StartTime>
            <Status>PROCESS_SUCCESS</Status>
        </Result>
    </Data>
    <Message>paramsIllegal</Message>
    <Success>true</Success>
    <HttpCode>InvalidParameter</HttpCode>
</QueryAsyncJobListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "43A0AEB6-45F4-4138-8E89-E1A5D63200E3",
  "Data" : {
    "CurrentPage" : 1,
    "PageSize" : 20,
    "TotalPage" : 2,
    "TotalRecord" : 22,
    "Result" : [ {
      "CallerParentId" : "1850343078585779",
      "EndTime" : "2023-01-04 17:18:44",
      "GmtCreate" : "2023-01-04 17:18:44",
      "JobId" : "49E2CC28-ED1D-4CC5-854D-7D0AE2B20976",
      "PopApiName" : "DetectVideoShot",
      "PopProduct" : "videorecog",
      "StartTime" : "2023-01-04 17:18:44",
      "Status" : "PROCESS_SUCCESS"
    } ]
  },
  "Message" : "paramsIllegal",
  "Success" : true,
  "HttpCode" : "InvalidParameter"
}

错误码

关于取消排队中异步任务的错误码，详情请参见常见错误码。