使用 ListJobs 查詢批量作業 - Object Storage Service

調用ListJobs介面查詢大量操作工作清單。

許可權說明

阿里雲帳號預設擁有全部許可權。阿里雲帳號下的RAM使用者或RAM角色預設沒有任何許可權，需要阿里雲帳號或帳號管理員通過RAM Policy或Bucket Policy授予操作許可權。

API	Action	說明
ListJobs	`oss:ListJobs`	查詢大量操作工作清單。

請求文法

GET /?batchJob&batchJobStatuses=JobStatuses&max-keys=MaxKeys&continuation-token=ContinuationToken HTTP/1.1
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

請求參數

名稱	類型	是否必選	樣本值	描述
batchJobStatuses	字串	否	Complete	任務狀態過濾條件，用於過濾查詢結果。如果不設定此參數，則預設返回所有狀態的任務。取值：Active、Cancelled、Cancelling、Complete、Completing、Failed、Failing、New、Paused、Pausing、Preparing、Ready、Suspended。支援取多個值，例如：Active \| Cancelled \| Cancelling 父節點：無
max-keys	整數	否	100	指定分頁查詢時，返回任務的最大數量。取值範圍：1~1000，預設值為100。父節點：無
continuation-token	字串	否	next-page-token-123	用於分頁查詢的分頁標記。當您一次查詢未能擷取所有結果時，伺服器會返回NextToken作為下一次查詢的continuation-token，以繼續擷取結果。長度為1~1024個字元，包含A-Z、a-z、0-9、+、:、/、=、?、#、-、_。父節點：無

要求標頭

此介面除支援公用要求標頭外，無特有要求標頭。更多資訊，請參見公用要求標頭（Common Request Headers）。

響應元素

名稱	類型	樣本值	描述
ListJobsResult	容器	無	響應的根節點。父節點：無子節點：NextToken、Jobs
NextToken	字串	next-page-token-456	下一頁的token。如果一次查詢未能擷取所有結果，則該響應中會包含此元素，可作為下次查詢的continuation-token以繼續擷取結果。父節點：ListJobsResult
Jobs	容器	無	工作清單容器。父節點：ListJobsResult 子節點：JobListDescriptor
JobListDescriptor	容器	無	任務描述資訊。父節點：Jobs 子節點：CreationTime、Description、JobId、Operation、Priority、ProgressSummary、Status、TerminationDate
CreationTime	時間戳記	1749983400	任務的建立時間。父節點：JobListDescriptor
Description	字串	大量設定對象標籤任務	任務的描述資訊。父節點：JobListDescriptor
JobId	字串	MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=	任務ID。父節點：JobListDescriptor
Operation	字串	PutObjectTagging	任務執行的操作。父節點：JobListDescriptor
Priority	整數	10	任務優先順序。父節點：JobListDescriptor
ProgressSummary	容器	無	任務當前執行進度匯總。父節點：JobListDescriptor 子節點：NumberOfTasksFailed、NumberOfTasksSucceeded、Timers、TotalNumberOfTasks
NumberOfTasksFailed	長整數	0	執行失敗條目數。父節點：ProgressSummary
NumberOfTasksSucceeded	長整數	1000	執行成功條目數。父節點：ProgressSummary
Timers	容器	無	執行時間資訊。父節點：ProgressSummary 子節點：ElapsedTimeInActiveSeconds
ElapsedTimeInActiveSeconds	長整數	3600	執行消耗時間（秒）。父節點：Timers
TotalNumberOfTasks	長整數	1000	總條目數。父節點：ProgressSummary
Status	字串	Complete	當前執行狀態。取值： New：新任務。作業剛建立，尚未開始準備。 Preparing：準備中。系統正在解析資訊清單檔、驗證許可權、初始化執行資源。 Ready：準備好。作業已完成準備工作，等待系統調度執行。 Suspended：掛起。作業需要使用者顯式確認才能繼續執行（建立時設定 ConfirmationRequired=true）。 Active：運行中。作業正在批量處理對象，可通過 ProgressSummary 查看即時進度。 Pausing：暫停中。系統暫停該作業的執行，僅針對於本作業。 Paused：暫停。作業已暫停，OSS服務會自動回復作業。 Completing：完成中。所有對象已處理完成，系統正在產生執行報告和清理資源。 Complete：運行完成。作業已成功執行完成（終態）。 Cancelling：取消中。系統正在取消作業。 Cancelled：取消完成。作業已被使用者主動取消（終態）。 Failing：失敗中。作業遇到嚴重錯誤，系統正在終止執行。 Failed：失敗。作業因系統級錯誤而終止，詳細原因見 FailureReasons 欄位（終態）。父節點：JobListDescriptor
TerminationDate	時間戳記	1749987000	終止時間。父節點：JobListDescriptor

回應標頭

此介面僅涉及公用回應標頭。更多資訊，請參見公用回應標頭（Common Response Headers）。

樣本

請求樣本

GET /?batchJob&batchJobStatuses=Complete&max-keys=10&continuation-token=next-page-token-123 HTTP/1.1
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

返回樣本

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<ListJobsResult>
   <NextToken>next-page-token-456</NextToken>
   <Jobs>
      <JobListDescriptor>
         <CreationTime>1749983400</CreationTime>
         <Description>大量設定對象標籤任務</Description>
         <JobId>MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=</JobId>
         <Operation>PutObjectTagging</Operation>
         <Priority>10</Priority>
         <ProgressSummary>
            <NumberOfTasksFailed>0</NumberOfTasksFailed>
            <NumberOfTasksSucceeded>1000</NumberOfTasksSucceeded>
            <Timers>
               <ElapsedTimeInActiveSeconds>3600</ElapsedTimeInActiveSeconds>
            </Timers>
            <TotalNumberOfTasks>1000</TotalNumberOfTasks>
         </ProgressSummary>
         <Status>Complete</Status>
         <TerminationDate>1749987000</TerminationDate>
      </JobListDescriptor>
   </Jobs>
</ListJobsResult>