全部產品
Search

搜尋本產品

    Object Storage Service：DescribeJob

    文件中心

    Object Storage Service：DescribeJob

    更新時間：Nov 07, 2025

    調用DescribeJob介面查詢指定大量操作任務的詳細資料和執行狀態。

    許可權說明

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

    API

    Action

    說明

    DescribeJob

    oss:DescribeJob

    查詢大量操作任務詳細資料。

    請求文法

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

    請求參數

    名稱

    類型

    是否必選

    樣本值

    描述

    batchJobId

    字串

    是

    MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=

    大量操作任務的ID，長度44個字元，不包含-、_，包含a-z、A-Z、0-9。

    子節點：無

    父節點：無

    要求標頭

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

    響應元素

    名稱

    類型

    樣本值

    描述

    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內容為空白。單個operation報錯不算失敗。

    子節點：JobFailure

    父節點：Job

    JobFailure

    容器

    無

    任務失敗詳情。

    子節點：FailureCode、FailureReason

    父節點：FailureReasons

    FailureCode

    字串

    InternalError

    失敗代碼。

    子節點：無

    父節點：JobFailure

    FailureReason

    字串

    Internal service error

    失敗原因。

    子節點：無

    父節點：JobFailure

    JobId

    字串

    MzRjZGU2NGQ3YTY5NGRhMTkxZmZhYzY5OTM5YTcxYWU=

    OSS為該任務產生的jobId。

    子節點：無

    父節點：Job

    Operation

    容器

    無

    執行的操作詳情。

    子節點：RestoreObject

    父節點：Job

    RestoreObject

    容器

    無

    恢複歸檔對象操作詳情。

    子節點：Days、Tier

    父節點：Operation

    Days

    整數

    7

    解凍天數。

    子節點：無

    父節點：RestoreObject

    Tier

    字串

    Standard

    解凍優先順序。

    子節點：無

    父節點：RestoreObject

    Report

    容器

    無

    報告配置。

    子節點：Bucket、Enabled、Prefix、ReportScope

    父節點：Job

    Bucket

    字串

    report-bucket

    報告輸出存放的bucket。

    子節點：無

    父節點：Report

    Enabled

    布爾值

    true

    是否需要輸出報告。

    子節點：無

    父節點：Report

    Prefix

    字串

    reports/

    報告輸出的首碼。

    子節點：無

    父節點：Report

    ReportScope

    字串

    AllTasks

    報告輸出範圍。

    子節點：無

    父節點：Report

    Manifest

    容器

    無

    清單資訊，與KeyPrefixManifestGenerator二選一。

    子節點：Location、Spec

    父節點：Job

    Location

    容器

    無

    清單位置。資訊清單檔所在的Bucket必須和大量操作任務在同一個地區（Region）。

    子節點：Bucket、ETag、Object、VersionId

    父節點：Manifest

    Bucket

    字串

    manifest-bucket

    manifest檔案所在的bucket。

    子節點：無

    父節點：Location

    ETag

    字串

    d41d8cd98f00b204e9800998ecf8427e

    manifest檔案的etag。

    子節點：無

    父節點：Location

    Object

    字串

    manifest.csv

    manifest檔案對應的object。

    子節點：無

    父節點：Location

    VersionId

    字串

    3/L4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

    manifest檔案對應的object versionId。

    子節點：無

    父節點：Location

    Spec

    容器

    無

    清單格式描述。

    子節點：Fields、Format

    父節點：Manifest

    Fields

    字串

    Bucket,Key

    清單欄位定義。

    子節點：無

    父節點：Spec

    Format

    字串

    OSS_BatchOperations_CSV_20250611

    格式，指明是Inventory輸出模式。

    子節點：無

    父節點：Spec

    Description

    字串

    大量復原歸檔對象任務

    任務描述資訊。

    子節點：無

    父節點：Job

    Priority

    整數

    10

    任務優先順序。

    子節點：無

    父節點：Job

    RoleArn

    字串

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

    IAM角色。

    子節點：無

    父節點：Job

    StatusUpdateReason

    字串

    Task completed successfully

    狀態更新原因。

    子節點：無

    父節點：Job

    KeyPrefixManifestGenerator

    容器

    無

    自動產生清單配置，與Manifest二選一。

    子節點：SourceBucket、Prefix

    父節點：Job

    SourceBucket

    字串

    source-bucket

    源bucket。

    子節點：無

    父節點：KeyPrefixManifestGenerator

    Prefix

    字串

    data/

    首碼。

    子節點：無

    父節點：KeyPrefixManifestGenerator

    ProgressSummary

    容器

    無

    任務執行進度匯總。

    子節點：NumberOfTasksFailed、NumberOfTasksSucceeded、Timers、TotalNumberOfTasks

    父節點：Job

    NumberOfTasksFailed

    長整數

    0

    執行失敗條目數。

    子節點：無

    父節點：ProgressSummary

    NumberOfTasksSucceeded

    長整數

    1000

    執行成功條目數。

    子節點：無

    父節點：ProgressSummary

    Timers

    容器

    無

    執行時間資訊。

    子節點：ElapsedTimeInActiveSeconds

    父節點：ProgressSummary

    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 欄位（終態）。

    子節點：無

    父節點：Job

    TerminationDate

    時間戳記

    1749987000

    任務結束時間。

    子節點：無

    父節點：Job

    回應標頭

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

    樣本

    • 請求樣本

      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>大量復原歸檔對象任務</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>