describe-job
The describe-job command queries the details and execution status of a specified batch job.
Usage notes
By default, an Alibaba Cloud account has the permissions to query the details of a batch job. To perform this operation by using a RAM user or Security Token Service (STS), you must have the oss:DescribeJob permission. For more information, see Grant a custom policy.
Command syntax
ossutil api describe-job --batch-job-id value|
Parameter |
Type |
Description |
|
--batch-job-id |
string |
The ID of the batch job. The value must be 44 characters in length and can contain lowercase letters (a-z), uppercase letters (A-Z), and digits (0-9). It cannot contain hyphens (-) or underscores (_). You can obtain the ID by using the create-job or list-jobs command. |
-
This command requires ossutil 2.4.1 or later.
-
For more information about the supported global command-line options, see Global command-line options.
Job statuses
The Status field in the command output indicates the current execution status of the job. Valid values:
|
Status |
Description |
|
New |
The job is created but has not started preparing. |
|
Preparing |
OSS is parsing the manifest file, verifying permissions, and initializing execution resources. |
|
Ready |
The job has finished preparing and is waiting to be scheduled. |
|
Suspended |
The job requires explicit confirmation before it continues, because ConfirmationRequired was set to true when the job was created. |
|
Active |
The job is processing objects in batches. You can view the real-time progress in ProgressSummary. |
|
Pausing |
OSS is pausing the job. |
|
Paused |
The job is paused. OSS automatically resumes the job. |
|
Completing |
All objects are processed. OSS is generating the execution report and releasing resources. |
|
Complete |
The job is complete. This is a final state. |
|
Cancelling |
OSS is canceling the job. |
|
Cancelled |
The job is canceled by the user. This is a final state. |
|
Failing |
The job encountered a critical error and OSS is terminating it. |
|
Failed |
The job is terminated because of a system error. For more information, see FailureReasons in the response. This is a final state. |
Usage examples
Query the details of the batch job whose ID is MzRjZGU2.
ossutil api describe-job --batch-job-id MzRjZGU2Query the details of the batch job whose ID is MzRjZGU2 and display the output in JSON format.
ossutil api describe-job --batch-job-id MzRjZGU2 --output-format jsonQuery the details of the batch job whose ID is MzRjZGU2 and display the output in YAML format.
ossutil api describe-job --batch-job-id MzRjZGU2 --output-format yaml