describe-job

更新时间:
复制 MD 格式

describe-job命令用于查询指定批量操作任务的详细信息和执行状态。

注意事项

阿里云账号默认拥有查询批量操作任务详细信息的权限。如果您需要通过RAM用户或者STS的方式进行操作,您必须拥有oss:DescribeJob权限。具体操作,请参见为RAM用户授予自定义的权限策略。

命令格式

ossutil api describe-job --batch-job-id value

参数

类型

说明

--batch-job-id

string

批量操作任务的ID。长度为44个字符,可以包含小写字母(a-z)、大写字母(A-Z)和数字(0-9),不包含短划线(-)和下划线(_)。您可以通过create-job命令或list-jobs命令获取该ID。

说明

任务状态说明

命令返回结果中的Status表示任务当前的执行状态,取值如下:

状态

说明

New

新任务。任务刚创建,尚未开始准备。

Preparing

准备中。系统正在解析清单文件、验证权限、初始化执行资源。

Ready

准备完成。任务已完成准备工作,等待系统调度执行。

Suspended

挂起。任务需要用户显式确认才能继续执行(创建时设置ConfirmationRequired为true)。

Active

运行中。任务正在批量处理Object,可通过ProgressSummary查看实时进度。

Pausing

暂停中。系统正在暂停该任务的执行。

Paused

已暂停。任务已暂停,OSS服务会自动恢复任务。

Completing

完成中。所有Object已处理完成,系统正在生成执行报告并清理资源。

Complete

运行完成。任务已成功执行完成(终态)。

Cancelling

取消中。系统正在取消任务。

Cancelled

已取消。任务已被用户主动取消(终态)。

Failing

失败中。任务遇到严重错误,系统正在终止执行。

Failed

已失败。任务因系统级错误而终止,详细原因请参见响应中的FailureReasons(终态)。

使用示例

查询ID为MzRjZGU2的批量操作任务的详细信息。

ossutil api describe-job --batch-job-id MzRjZGU2

查询ID为MzRjZGU2的批量操作任务的详细信息,并以JSON格式输出。

ossutil api describe-job --batch-job-id MzRjZGU2 --output-format json

查询ID为MzRjZGU2的批量操作任务的详细信息,并以YAML格式输出。

ossutil api describe-job --batch-job-id MzRjZGU2 --output-format yaml