调用DescribeJob接口查询批量操作任务详情与状态-对象存储-阿里云-对象存储(OSS)-阿里云帮助中心

调用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>

命令行工具ossutil

DescribeJob接口所对应的ossutil命令，请参见describe-job。