すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:ListJobs

最終更新日:Nov 09, 2025

ListJobs 操作を呼び出して、バッチジョブをクエリできます。

権限

デフォルトでは、Alibaba Cloud アカウントはすべての権限を持っています。ただし、Resource Access Management (RAM) ユーザーまたは RAM ロールには権限がありません。Alibaba Cloud アカウントまたは管理者は、RAM ポリシーまたはバケットポリシーを使用して、RAM ユーザーまたは RAM ロールに権限を付与する必要があります。

API

アクション

説明

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

String

いいえ

Complete

ジョブステータスのフィルター条件。このパラメーターはクエリ結果をフィルターします。このパラメーターを設定しない場合、デフォルトですべての状態のジョブが返されます。有効な値: Active、Cancelled、Cancelling、Complete、Completing、Failed、Failing、New、Paused、Pausing、Preparing、Ready、および Suspended。Active | Cancelled | Cancelling のように、複数の値を指定できます。

親ノード: なし

max-keys

Integer

いいえ

100

ページングクエリで返すジョブの最大数。値は 1 から 1,000 までの整数である必要があります。デフォルト値は 100 です。

親ノード: なし

continuation-token

String

いいえ

next-page-token-123

ページングクエリのページネーショントークン。クエリですべての結果が返されない場合、サーバーは NextToken を返します。このトークンを次のクエリの continuation-token として使用して、残りの結果を取得します。トークンの長さは 1~1,024 文字で、大文字 (A~Z)、小文字 (a~z)、数字 (0~9)、および次の特殊文字を含めることができます: +、:、/、=、?、#、-、_。

親ノード: なし

リクエストヘッダー

この操作は、共通のリクエストヘッダーのみを使用します。詳細については、「共通リクエストヘッダー」をご参照ください。

レスポンス要素

名前

タイプ

説明

ListJobsResult

Container

なし

応答のルートノード。

親ノード: なし

子ノード: NextToken および Jobs

NextToken

String

next-page-token-456

次のページのトークン。クエリですべての結果が返されない場合、この要素が応答に含まれます。このトークンを次のクエリの continuation-token として使用して、残りの結果を取得できます。

親ノード: ListJobsResult

Jobs

Container

なし

ジョブのリストのコンテナー。

親ノード: ListJobsResult

子ノード: JobListDescriptor

JobListDescriptor

Container

なし

ジョブの説明。

親ノード: Jobs

子ノード: CreationTime、Description、JobId、Operation、Priority、ProgressSummary、Status、および TerminationDate

CreationTime

Timestamp

1749983400

ジョブが作成された時間。

親ノード: JobListDescriptor

Description

String

Batch job for setting object tags

ジョブの説明。

親ノード: JobListDescriptor

JobId

String

MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=

ジョブ ID。

親ノード: JobListDescriptor

Operation

String

PutObjectTagging

ジョブが実行する操作。

親ノード: JobListDescriptor

Priority

Integer

10

ジョブの優先度。

親ノード: JobListDescriptor

ProgressSummary

Container

なし

現在のジョブの進行状況の概要。

親ノード: JobListDescriptor

子ノード: NumberOfTasksFailed、NumberOfTasksSucceeded、Timers、および TotalNumberOfTasks

NumberOfTasksFailed

Long

0

失敗したタスクの数。

親ノード: ProgressSummary

NumberOfTasksSucceeded

Long

1000

成功したタスクの数。

親ノード: ProgressSummary

Timers

Container

なし

実行時間に関する情報。

親ノード: ProgressSummary

子ノード: ElapsedTimeInActiveSeconds

ElapsedTimeInActiveSeconds

Long

3600

実行時間 (秒)。

親ノード: Timers

TotalNumberOfTasks

Long

1000

タスクの総数。

親ノード: ProgressSummary

Status

String

Complete

現在の実行状態。有効な値:

  • New: ジョブは新規作成され、準備は開始されていません。

  • Preparing: システムはマニフェストファイルを解析し、権限を認証し、リソースを初期化しています。

  • Ready: ジョブは準備を完了し、システムによるスケジュールと実行を待機しています。

  • Suspended: ジョブを続行するには、ユーザーからの明示的な確認が必要です。これは、ジョブ作成時に ConfirmationRequired が true に設定されている場合に発生します。

  • Active: ジョブはオブジェクトをバッチ処理しています。ProgressSummary でリアルタイムの進行状況を表示できます。

  • Pausing: システムはジョブを一時停止しています。これはこのジョブにのみ適用されます。

  • Paused: ジョブは一時停止しています。OSS サービスはジョブを自動的に再開します。

  • Completing: すべてのオブジェクトが処理されました。システムは実行レポートを生成し、リソースをクリーンアップしています。

  • Complete: ジョブは正常に完了しました。これは望ましい状態です。

  • Cancelling: システムはジョブをキャンセルしています。

  • Cancelled: ジョブはユーザーによってキャンセルされました。これは望ましい状態です。

  • Failing: ジョブで重大なエラーが発生し、システムがその実行を停止しています。

  • Failed: システムレベルのエラーが原因でジョブが停止しました。原因の詳細については、FailureReasons フィールドをご参照ください。これは望ましい状態です。

親ノード: JobListDescriptor

TerminationDate

Timestamp

1749987000

ジョブが停止した時間。

親ノード: JobListDescriptor

レスポンスヘッダー

この操作は、共通のレスポンスヘッダーのみを使用します。詳細については、「共通レスポンスヘッダー」をご参照ください。

  • リクエスト例

    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>Batch job for setting object tags</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>