Documentation

Documentation

mc batch describe

Changed in version MinIO: RELEASE.2022-10-08T20-11-00Z 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.

mc batch describe myminio KwSysDpxcBU9FNhGkn2dCf

The command has the following syntax:

mc [GLOBALFLAGS] batch describe TARGET           \
                                JOBID
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters seperated 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
Required

The alias for the MinIO deployment to look for the Job ID.

JOBID
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:

mc batch describe myminio KwSysDpxcBU9FNhGkn2dCf
  • Replace myminio with the alias of the MinIO deployment that should run the job.

  • Replace KwSysDpxcBU9FNhGkn2dCf with the ID of the job to define.

The output of the above command is similar to the following:

mc batch describe myminio KwSysDpxcBU9FNhGkn2dCf
replicate:
  apiVersion: v1
...

Note, this example is truncated. The output is the full job definition for the specified job.

S3 Compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested MinIO and AWS S3 for expected functionality and behavior.

MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While mc commands may work as documented, any such usage is at your own risk.