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.
The following command displays information on all objects in the
mydata
bucket on the myminio
MinIO deployment:
mc stat --recursive myminio/mydata
The command has the following syntax:
mc [GLOBALFLAGS] stat \
[--encrypt-key "value"] \
[--recursive] \
[--rewind "string"] \
[--versions] \
[--version-id "string"]* \
ALIAS [ALIAS ...]
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.
mc stat --version-id
is mutually exclusive with multiple
parameters. See the reference documentation for more information.
Parameters
- ALIAS
The 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).
- Each
Enclose the entire list of key-value pairs passed to
--encrypt-key
in double quotes"
.--encrypt-key
can use theMC_ENCRYPT_KEY
environment variable for retrieving a list of encryption key-value pairs as an alternative to specifying them on the command line.
- --rewind
- Optional
Directs
mc stat
to operate only on the object version(s) that existed at specified point-in-time.To rewind to a specific date in the past, specify the date as an ISO8601-formatted timestamp. For example:
--rewind "2020.03.24T10:00"
.To rewind a duration in time, specify the duration as a string in
#d#hh#mm#ss
format. For example:--rewind "1d2hh3mm4ss"
.
--rewind
requires that the specifiedALIAS
be an S3-compatible service that supports Bucket Versioning. For MinIO deployments, usemc version
to enable or disable bucket versioning.
- --versions
- Optional
Directs
mc stat
to operate on all object versions that exist in the bucket.--versions
requires that the specifiedALIAS
be an S3-compatible service that supports Bucket Versioning. For MinIO deployments, usemc version
to enable or disable bucket versioning.Use
--versions
and--rewind
together to remove all object versions which existed at a specific point in time.
- --version-id, vid
Optional Directs
mc stat
to operate only on the specified object version.--version-id
requires that the specifiedALIAS
be an S3-compatible service that supports Bucket Versioning. For MinIO deployments, usemc version
to enable or disable bucket versioning.Mutually exclusive with any of the following flags:
Examples
mc stat ALIAS/PATH
Use mc stat
with the --recursive
option
to apply the operation to all objects in the bucket:
mc stat --recursive ALIAS/PATH
Behavior
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 mc commands may work as documented, any such usage is at your own risk.