mc batch describe
Changed: MinIO
RELEASE.2022-10-09T21-10-59Z or later
Syntax
The mc batch describe command outputs the job definition for a specified job ID.
You must specify the job ID. To find the job ID, use mc batch list.
The following command outputs the job definition for the job identified as KwSysDpxcBU9FNhGkn2dCf.
The command has the following syntax:
- Brackets
[]indicate optional parameters. - Parameters sharing a line are mutually dependent.
- Parameters separated using the pipe
|operator are mutually exclusive.
Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.
Parameters
TARGET
mc-cmd
Required
The alias for the MinIO deployment to look for the Job ID.
JOBID
mc-cmd
Required
The unique identifier of a job to describe. To find the ID of a job, use mc batch list.
Global Flags
This command supports any of the global flags.
Example
Show the Definition of an In Progress Batch Job
The following command provides the full job definition of a specific job at alias myminio:
- Replace
myminiowith thealiasof the MinIO deployment that should run the job. - Replace
KwSysDpxcBU9FNhGkn2dCfwith the ID of the job to define.
The output of the above command is similar to the following:
Note, this example is truncated. The output is the full job definition for the specified job.
S3 Compatibility
SILO is the supported server for PGSTY mcli; compatibility with upstream MinIO and other S3 services is best effort.
Permissions
You must have the admin:DescribeBatchJobs permission to describe jobs on the deployment.