本文介紹查詢異步任務(wù)列表QueryAsyncJobList的語法及示例。

功能描述

在您成功提交異步任務(wù)以后，可以通過QueryAsyncJobList來查詢已經(jīng)提交的任務(wù)信息列表。

說明
  • 您可以進入在線咨詢獲取在線人工幫助。
  • 阿里云視覺智能開放平臺視覺AI能力API接入、接口使用或問題咨詢等，請通過釘釘群（23109592）加入阿里云視覺智能開放平臺咨詢?nèi)郝?lián)系我們。

示例代碼

該能力常用語言查詢異步任務(wù)列表的示例代碼，請參見查詢異步任務(wù)列表示例代碼。

調(diào)用說明

  • 只能查詢當(dāng)前賬號提交的異步任務(wù)。
  • 只有開通了對應(yīng)能力以后才可以根據(jù)類目名稱和能力接口名稱進行篩選查詢。
  • 當(dāng)前接口調(diào)用每5秒內(nèi)只允許請求1次，如果返回報錯，請5秒后再次重試。
  • 無法查詢時間長度超過24小時以外的數(shù)據(jù)。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 QueryAsyncJobList

系統(tǒng)規(guī)定參數(shù)。取值：QueryAsyncJobList。
StartTime String 否 2023-01-04 00:00:00

開始時間。
EndTime String 否 2023-01-04 23:00:00

結(jié)束時間。
JobId String 否 E75FE679-0303-4DD1-8252-1143B4FA8A27

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

類目英文名，詳情可參考能力開通中的類目英文名。
PopApiName String 否 RecognizeIdentityCard

能力接口名，詳情可參考能力開通中的能力接口名。
Status String 否 PROCESS_SUCCESS

異步任務(wù)狀態(tài)。包括：

  • QUEUING：任務(wù)排隊中
  • PROCESSING：異步處理中
  • PROCESS_SUCCESS：處理成功
  • PROCESS_FAILED：處理失敗
  • TIMEOUT_FAILED：任務(wù)超時未處理完成
  • LIMIT_RETRY_FAILED：超過最大重試次數(shù)
  • JOB_CANCELED：任務(wù)取消
PageNum String 否 1

起始頁。
PageSize String 否 20

每頁查詢條數(shù)，最大500條。

返回數(shù)據(jù)

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

請求ID。
Data Object

返回的數(shù)據(jù)內(nèi)容。
CurrentPage Integer 1

當(dāng)前頁。
PageSize Integer 20

每頁查詢條數(shù)。
TotalPage Integer 2

總頁數(shù)。
TotalRecord Integer 22

總條數(shù)。
Result Array of result

查詢結(jié)果。
CallerParentId String 1850343078585779

任務(wù)提交人ID。
EndTime String 2023-01-04 17:18:44

任務(wù)結(jié)束時間。
GmtCreate String 2023-01-04 17:18:44

任務(wù)創(chuàng)建時間。
JobId String 49E2CC28-ED1D-4CC5-854D-7D0AE2B20976

異步任務(wù)ID。
PopApiName String DetectVideoShot

能力接口名，詳情可參考能力開通中的能力接口名。
PopProduct String videorecog

類目英文名，詳情可參考能力開通中的類目英文名。
StartTime String 2023-01-04 17:18:44

任務(wù)開始時間。
Status String PROCESS_SUCCESS

異步任務(wù)狀態(tài)。包括：

  • QUEUING：任務(wù)排隊中
  • PROCESSING：異步處理中
  • PROCESS_SUCCESS：處理成功
  • PROCESS_FAILED：處理失敗
  • TIMEOUT_FAILED：任務(wù)超時未處理完成
  • LIMIT_RETRY_FAILED：超過最大重試次數(shù)
Message String paramsIllegal

異步任務(wù)錯誤碼信息。
Success Boolean true

是否調(diào)用成功，取值true或false。
HttpCode String InvalidParameter

異步任務(wù)錯誤碼。

SDK參考

阿里云視覺AI能力推薦使用SDK調(diào)用，支持多種編程語言，具體可參見SDK總覽。

示例

請求示例

http(s)://viapi.cn-shanghai.aliyuncs.com/?action=QueryAsyncJobList //更多關(guān)于訪問域名（Endpoint）信息，請參見：http://bestwisewords.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      
&<公共請求參數(shù)>

正常返回示例

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"
}

錯誤碼

關(guān)于取消排隊中異步任務(wù)的錯誤碼，詳情請參見常見錯誤碼。