mc batch list

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

Syntax

Example Syntax

The command has the following syntax:

mc [GLOBALFLAGS] batch list TARGET            \
                            [--bucket string] \
                            [--type string]

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

Required

The alias of the deployment for which you want to list jobs in progress.

--bucket

Optional

Filter batch jobs for a specific bucket.

Use this flag to list only jobs that operate on the specified bucket.

--type

Optional

Filter batch jobs by job type.

Valid types include replicate, keyrotate, expire, and other batch job types.

Global flags

This command supports any of the global flags.

Examples

List all `replicate` type batch jobs

The following command lists the replicate type job(s) on the deployment at alias myaistor:

mc batch list myaistor --type "replicate"

Replace myaistor with the alias of the AIStor deployment that should run the job.

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

ID                      TYPE            USER            STARTED        STATUS
E24HH4nNMcgY5taynaPfxu  replicate       minioadmin      1 minute ago   in-progress

List batch jobs for a specific bucket

The following command lists all batch jobs operating on a specific bucket:

mc batch list myaistor --bucket "mybucket"

Combine filters

The following command lists only expire type jobs for a specific bucket:

mc batch list myaistor --type "expire" --bucket "mybucket"

S3 compatibility

The mc command-line tool is built for compatibility with the AWS S3 API and is tested with AIStor 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.

Permissions

You must have the admin:ListBatchJobs permission to list jobs on the deployment.