すべてのプロダクト
Search

このプロダクト

    Object Storage Service:DescribeJob

    ドキュメントセンター

    Object Storage Service:DescribeJob

    最終更新日:Nov 09, 2025

    DescribeJob 操作を呼び出して、指定されたバッチ操作ジョブの詳細と実行ステータスをクエリできます。

    権限

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

    API

    アクション

    説明

    DescribeJob

    oss:DescribeJob

    バッチ操作ジョブの詳細をクエリします。

    リクエスト構文

    GET /?batchJob&batchJobId=xxx HTTP/1.1
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

    リクエストパラメーター

    名前

    型

    必須

    例

    説明

    batchJobId

    String

    はい

    MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=

    バッチ操作ジョブの ID。ID は 44 文字の長さで、文字と数字が含まれます。ハイフン (-) やアンダースコア (_) は含まれません。

    子ノード: なし

    親ノード: なし

    リクエストヘッダー

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

    レスポンス要素

    名前

    型

    例

    説明

    DescribeJobResult

    コンテナー

    なし

    レスポンスのルートノード。

    子ノード: Job

    親ノード: なし

    Job

    コンテナー

    なし

    ジョブ詳細のコンテナー。

    子ノード: ConfirmationRequired、CreationTime、FailureReasons、JobId、Operation、Report、Manifest、Description、Priority、RoleArn、StatusUpdateReason、KeyPrefixManifestGenerator、ProgressSummary、Status、および TerminationDate

    親ノード: DescribeJobResult

    ConfirmationRequired

    ブール値

    false

    ジョブの実行前に確認が必要かどうかを示します。

    子ノード: なし

    親ノード: Job

    CreationTime

    タイムスタンプ

    1749983400

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

    子ノード: なし

    親ノード: Job

    FailureReasons

    コンテナー

    なし

    ジョブが失敗した理由。このノードは、ジョブが成功した場合でも返されます。この場合、JobFailure 子ノードは空です。単一の操作でのエラーは、ジョブの失敗にはつながりません。

    子ノード: JobFailure

    親ノード: Job

    JobFailure

    コンテナー

    なし

    ジョブの失敗に関する詳細。

    子ノード: FailureCode および FailureReason

    親ノード: FailureReasons

    FailureCode

    String

    InternalError

    エラーコード。

    子ノード: なし

    親ノード: JobFailure

    FailureReason

    String

    Internal service error

    エラーメッセージ。

    子ノード: なし

    親ノード: JobFailure

    JobId

    String

    MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=

    OSS がジョブに対して生成するジョブ ID。

    子ノード: なし

    親ノード: Job

    Operation

    コンテナー

    なし

    実行する操作に関する詳細。

    子ノード: RestoreObject

    親ノード: Job

    RestoreObject

    コンテナー

    なし

    アーカイブオブジェクトを解凍する操作に関する詳細。

    子ノード: Days および Tier

    親ノード: Operation

    Days

    Integer

    7

    解凍されたオブジェクトがアクセス可能なままである日数。

    子ノード: なし

    親ノード: RestoreObject

    Tier

    String

    Standard

    復元優先度

    子ノード: なし

    親ノード: RestoreObject

    Report

    コンテナー

    なし

    レポートの構成。

    子ノード: Bucket、Enabled、Prefix、および ReportScope

    親ノード: Job

    Bucket

    String

    report-bucket

    レポートが保存されるバケット。

    子ノード: なし

    親ノード: Report

    Enabled

    ブール値

    true

    レポートが生成されるかどうかを示します。

    子ノード: なし

    親ノード: Report

    Prefix

    String

    reports/

    レポートのプレフィックス。

    子ノード: なし

    親ノード: Report

    ReportScope

    String

    AllTasks

    レポートの範囲。

    子ノード: なし

    親ノード: Report

    Manifest

    コンテナー

    なし

    マニフェスト情報。このパラメーターまたは KeyPrefixManifestGenerator のいずれかを指定できます。

    子ノード: Location および Spec

    親ノード: Job

    Location

    コンテナー

    なし

    マニフェストの場所。マニフェストファイルを保存するバケットは、バッチ操作ジョブと同じリージョンにある必要があります。

    子ノード: Bucket、ETag、Object、および VersionId

    親ノード: Manifest

    Bucket

    String

    manifest-bucket

    マニフェストファイルが保存されるバケット。

    子ノード: なし

    親ノード: Location

    ETag

    String

    d41d8cd98f00b204e9800998ecf8427e

    マニフェストファイルの ETag。

    子ノード: なし

    親ノード: Location

    Object

    String

    manifest.csv

    マニフェストファイルに対応するオブジェクト。

    子ノード: なし

    親ノード: Location

    VersionId

    String

    3/L4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

    マニフェストファイルに対応するオブジェクトのバージョン ID。

    子ノード: なし

    親ノード: Location

    Spec

    コンテナー

    なし

    マニフェストフォーマットの説明。

    子ノード: Fields および Format

    親ノード: Manifest

    Fields

    String

    Bucket,Key

    マニフェスト内のフィールド。

    子ノード: なし

    親ノード: Spec

    Format

    String

    OSS_BatchOperations_CSV_20250611

    フォーマット。これは、出力がインベントリレポートからのものであることを示します。

    子ノード: なし

    親ノード: Spec

    Description

    String

    Batch restore archive objects job

    ジョブの説明。

    子ノード: なし

    親ノード: Job

    Priority

    Integer

    10

    ジョブの優先度。

    子ノード: なし

    親ノード: Job

    RoleArn

    String

    arn:acs:ram::uid:role/BatchOperationRole

    IAM ロール

    子ノード: なし

    親ノード: Job

    StatusUpdateReason

    String

    Task completed successfully

    ステータス更新の理由。

    子ノード: なし

    親ノード: Job

    KeyPrefixManifestGenerator

    コンテナー

    なし

    マニフェストを自動的に生成するための構成。このパラメーターまたは Manifest のいずれかを指定できます。

    子ノード: SourceBucket および Prefix

    親ノード: Job

    SourceBucket

    String

    source-bucket

    ソースバケット。

    子ノード: なし

    親ノード: KeyPrefixManifestGenerator

    Prefix

    String

    data/

    プレフィックス。

    子ノード: なし

    親ノード: KeyPrefixManifestGenerator

    ProgressSummary

    コンテナー

    なし

    ジョブの進捗のまとめ。

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

    親ノード: Job

    NumberOfTasksFailed

    Long

    0

    失敗したタスクの数。

    子ノード: なし

    親ノード: ProgressSummary

    NumberOfTasksSucceeded

    Long

    1000

    成功したタスクの数。

    子ノード: なし

    親ノード: ProgressSummary

    Timers

    コンテナー

    なし

    実行時間に関する情報。

    子ノード: ElapsedTimeInActiveSeconds

    親ノード: ProgressSummary

    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」フィールドをご参照ください。これは最終状態です。

    子ノード: なし

    親ノード: Job

    TerminationDate

    タイムスタンプ

    1749987000

    ジョブが終了した時間。

    子ノード: なし

    親ノード: Job

    レスポンスヘッダー

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

    例

    • リクエスト例

      GET /?batchJob&batchJobId=MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU= HTTP/1.1
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

    • レスポンス例

      HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<DescribeJobResult>
  <Job>
    <ConfirmationRequired>false</ConfirmationRequired>
    <CreationTime>1749983400</CreationTime>
    <JobId>MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=</JobId>
    <Operation>
      <RestoreObject>
        <Days>7</Days>
        <Tier>Standard</Tier>
      </RestoreObject>
    </Operation>
    <Report>
      <Bucket>report-bucket</Bucket>
      <Enabled>true</Enabled>
      <Prefix>reports/</Prefix>
      <ReportScope>AllTasks</ReportScope>
    </Report>
    <Manifest>
      <Location>
        <ETag>d41d8cd98f00b204e9800998ecf8427e</ETag>
        <Bucket>manifest-bucket</Bucket>
        <Object>manifest.csv</Object>
        <VersionId>3/L4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</VersionId>
      </Location>
      <Spec>
        <Fields>Bucket,Key</Fields>
        <Format>OSS_BatchOperations_CSV_20250611</Format>
      </Spec>
    </Manifest>
    <Description>Batch restore archive objects job</Description>
    <Priority>10</Priority>
    <RoleArn>arn:acs:ram::uid:role/BatchOperationRole</RoleArn>
    <StatusUpdateReason>Task completed successfully</StatusUpdateReason>
    <ProgressSummary>
      <NumberOfTasksFailed>0</NumberOfTasksFailed>
      <NumberOfTasksSucceeded>1000</NumberOfTasksSucceeded>
      <Timers>
        <ElapsedTimeInActiveSeconds>3600</ElapsedTimeInActiveSeconds>
      </Timers>
      <TotalNumberOfTasks>1000</TotalNumberOfTasks>
    </ProgressSummary>
    <Status>Complete</Status>
    <TerminationDate>1749987000</TerminationDate>
  </Job>
</DescribeJobResult>