mc batch list — MinIO Object Storage for Linux (original) (raw)

Table of Contents

Syntax
- Parameters
- Global Flags
Example
- List all replicate type batch jobs
- S3 Compatibility
Permissions

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.

EXAMPLE

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

SYNTAX

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 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.

--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 lists the replicate` type job(s) 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 with 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 mccommands 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.