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 it to retrieve bucket 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 myminio/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

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

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

Display Object Details

The following example displays details of the object myfile.txt in the bucket mybucket:

mc stat myminio/mybucket/myfile.txt

The output resembles the following:

Name      : myfile.txt
Date      : 2024-07-16 15:40:02 MDT 
Size      : 6.0 KiB 
ETag      : 3b38f7b05a0c42acdc377e60b2a74ddf 
Type      : file 
Metadata  :
  Content-Type: text/plain 

You can specify more than one object by adding multiple paths:

mc stat myminio/mybucket/file1.txt myminio/yourbucket/file2.txt

To display detail for all objects in a bucket, use ~mc stat --recursive. The following example displays details for all objects in bucket mybucket:

mc stat --recursive myminio/mybucket

The output resembles the following:

Name      : file1.txt
Date      : 2024-07-16 15:40:02 MDT
Size      : 6.0 KiB
ETag      : 3b38f7b05a0c42acdc377e60b2a74ddf
Type      : file
Metadata  :
  Content-Type: text/plain

Name      : file2.txt
Date      : 2024-07-26 10:45:19 MDT
Size      : 6.0 KiB
ETag      : 3b38f7b05a0c42acdc377e60b2a74ddf
Type      : file
Metadata  :
  Content-Type: text/plain

Display Bucket Details

The following example displays information about the bucket mybucket on the myminio MinIO deployment:

mc stat myminio/mybucket

The output resembles the following:

Name      : mybucket
Date      : 2024-07-26 10:56:43 MDT 
Size      : N/A    
Type      : folder 

Properties:
  Versioning: Un-versioned
  Location: us-east-1
  Anonymous: Disabled
  ILM: Disabled

Usage:
      Total size: 6.0 KiB
   Objects count: 1
  Versions count: 0

Object sizes histogram:
   1 object(s) BETWEEN_1024B_AND_1_MB
   1 object(s) BETWEEN_1024_B_AND_64_KB
   0 object(s) BETWEEN_10_MB_AND_64_MB
   0 object(s) BETWEEN_128_MB_AND_512_MB
   0 object(s) BETWEEN_1_MB_AND_10_MB
   0 object(s) BETWEEN_256_KB_AND_512_KB
   0 object(s) BETWEEN_512_KB_AND_1_MB
   0 object(s) BETWEEN_64_KB_AND_256_KB
   0 object(s) BETWEEN_64_MB_AND_128_MB
   0 object(s) GREATER_THAN_512_MB
   0 object(s) LESS_THAN_1024_B

Count of Objects in a Bucket

To show the number of objects in a bucket, use --json <mc.--json> and extract the value of objectsCount with a JSON parser:

The following example uses the jq utility:

mc stat myminio/mybucket --json | jq '.Usage.objectsCount'

Behavior

S3 Compatibility