Documentation

Documentation

mc batch list

Changed in version MinIO: RELEASE.2022-10-08T20-11-00Z or later

Syntax

The mc batch list command outputs a list of the batch jobs currently in progress on a deployment.

The following command outputs a list of all jobs currently in progress on the myminio alias.

mc batch list myminio

The command has the following syntax:

mc [GLOBALFLAGS] batch list TARGET           \
                            --type "string"
  • 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 and bucket on the MinIO deployment to which to add the object lifecycle management rule.

--type
Optional

List batch jobs only of a certain type.

Global Flags

This command supports any of the global flags.

Example

List all replicate type batch jobs

The following command starts the batch of job(s) defined in the file replication.yaml on the deployment at alias myminio:

mc batch list myminio --type "replicate"
  • Replace myminio with the alias of the MinIO deployment that should run the job.

  • Replace replicate with the job type to output.

    Currently, mc batch only supports the replicate job type.

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

ID                      TYPE            USER            STARTED
E24HH4nNMcgY5taynaPfxu  replicate       minioadmin      1 minute ago

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.