1
0
mirror of https://github.com/minio/docs.git synced 2025-04-25 17:22:39 +03:00
docs/source/reference/minio-mc/mc-batch-describe.rst
Daryl White f37aee8416
Clean up of batch framework and mc batch docs (#749)
- Removes bad copy paste info about ilm from batch command docs.
- Clarifies that batch files are one task only.
- Fixes source type from `s3` to `minio`.
- Cleans up indentation errors in replicate yaml example.
- Replicate task is local to remote only.

Closes #748
2023-03-06 16:12:44 -06:00

2.6 KiB

mc batch describe

minio

Table of Contents

mc batch describe

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.

EXAMPLE

The following command outputs the job definition for the job identified as KwSysDpxcBU9FNhGkn2dCf.

mc batch describe myminio KwSysDpxcBU9FNhGkn2dCf

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] batch describe TARGET           \
                                JOBID

Parameters

TARGET

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

JOBID

The unique identifier of a job to describe. To find the ID of a job, use mc batch list.

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 <mc alias> myminio:

mc batch describe myminio KwSysDpxcBU9FNhGkn2dCf
  • Replace myminio with the alias <mc 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

Permissions

You must have the admin:DescribeBatchJobs permission to describe jobs on the deployment.