docs/source/reference/minio-mc/mc-stat.rst

mc stat

minio

Table of Contents

mc stat

Syntax

The mc stat command displays information on objects in a MinIO bucket, including object metadata.

You can also use mc stat against the local filesystem to produce similar results to the stat commandline tool.

EXAMPLE

The following command displays information on all objects in the mydata bucket on the myminio MinIO deployment:

mc stat --recursive myminio/mydata

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] stat                      \
                 [--encrypt-key "value"]   \
                 [--recursive]             \
                 [--rewind "string"]       \
                 [--versions]              \
                 [--version-id "string"]*  \
                 ALIAS [ALIAS ...]

mc stat --version-id is mutually exclusive with multiple parameters. See the reference documentation for more information.

Parameters

ALIAS

The alias <alias> of a MinIO deployment and the full path to the object for which to retrieve detailed information. For example:

mc stat myminio/mybucket/myobject.txt

You can specify multiple objects on the same or different MinIO deployments:

mc stat play/mybucket/myobject.txt myminio/mybucket/myobject.txt

If specifying the path to a bucket or bucket prefixy, you must include the mc stat --recursive flag:

mc stat --recursive myminio/mybucket/

For retrieving information on a file from a local filesystem, specify the full path to that file:

mc stat ~/data/myobject.txt

--encrypt-key

Optional Encrypt or decrypt objects using server-side encryption with client-specified keys. Specify key-value pairs as KEY=VALUE.

• Each KEY represents a bucket or object.

• Each VALUE represents the data key to use for encrypting

  object(s).

Enclose the entire list of key-value pairs passed to ~mc stat --encrypt-key in double quotes ".

~mc stat --encrypt-key can use the MC_ENCRYPT_KEY environment variable for retrieving a list of encryption key-value pairs as an alternative to specifying them on the command line.

--recursive, r

Optional Recursively mc stat the contents of the MinIO bucket specified to ~mc stat ALIAS.

--rewind

--versions

Use ~mc stat --versions and ~mc stat --rewind together to remove all object versions which existed at a specific point in time.

--version-id, vid

Mutually exclusive with any of the following flags:

• ~mc stat --versions
• ~mc stat --rewind
• ~mc stat --recursive

Examples

Single Object

mc stat ALIAS/PATH

• Replace ALIAS <mc stat ALIAS> with the alias <mc alias> of the S3-compatible host.
• Replace PATH <mc stat ALIAS> with the path to the bucket or object on the S3-compatible host.

Object(s) in Bucket

Use mc stat with the ~mc stat --recursive option to apply the operation to all objects in the bucket:

mc stat --recursive ALIAS/PATH

• Replace ALIAS <mc stat ALIAS> with the alias <mc alias> of the S3-compatible host.
• Replace PATH <mc stat ALIAS> with the path to the bucket or object on the S3-compatible host.

Behavior

S3 Compatibility