mc inventory status

The mc inventory status command displays the execution status of an inventory job.

The command shows comprehensive information about the job’s current state, progress, and execution history. You can optionally watch the status in real-time as the job progresses.

Syntax

Parameters

TARGET/BUCKET

The full path to the bucket containing the inventory configuration. Specify both the alias and bucket name in the format ALIAS/BUCKET.

When using --all, specify only the TARGET alias without a bucket name.

For example:

mc inventory status myaistor/mybucket my-inventory-id

ID

The unique identifier of the inventory configuration for which to display status.

Not required when using --all.

For example:

mc inventory status myaistor/mybucket monthly-report

--all

Alias: -a

Optional

Show the status of all inventory jobs across all buckets on the deployment.

When using this flag, specify only the TARGET alias without a bucket name or job ID. The command displays a table showing all inventory jobs with their bucket, job ID, state, schedule, start time, duration, matched count, and error count.

For example:

mc inventory status --all myaistor

--watch

Alias: -w

Optional

Watch the inventory job status and display real-time updates as the job progresses.

The status refreshes at the interval specified by --watch-interval and displays a spinner animation during execution. Press Ctrl+C to stop watching and exit.

You can combine --watch with --all to watch all inventory jobs across all buckets.

For example:

mc inventory status --watch myaistor/mybucket myjob-id

--watch-interval

Optional

The interval between status updates when using --watch.

Specify a duration value such as 2s, 5s, or 10s. The minimum interval is 2s to avoid excessive server load. Values less than 2s are automatically adjusted to 2s.

Default: 2s

For example:

mc inventory status --watch --watch-interval 10s myaistor/mybucket myjob-id

Global flags

This command supports any of the global flags.

Examples

Display job status

The following command displays the current status of an inventory job:

mc inventory status myaistor/mybucket weekly-inventory
  • Replace myaistor with the alias of your AIStor deployment.
  • Replace mybucket with the name of the bucket.
  • Replace weekly-inventory with the inventory configuration ID.

Display status of all inventory jobs

The following command displays the status of all inventory jobs across all buckets:

mc inventory status --all myaistor

Watch all inventory jobs

The following command watches all inventory jobs with a 5-second refresh interval:

mc inventory status --watch --all --watch-interval 5s myaistor

Example output

Single job status

The following example shows the output for a single inventory job:

$ mc inventory status myaistor/mybucket weekly-inventory
JobID:               weekly-inventory
State:               completed
Bucket:              mybucket
User:                admin
Access Key:          minio-admin
Schedule:            weekly
Scanned Objects:     1.2 GiB
Scanned Count:       15423
Matched Objects:     856 MiB
Matched Count:       10256
Records Written:     10256
Output Files:        3
Execution Time:      2m34s
Num Starts:          4
Manifest Path:       mybucket/_inventory/weekly-inventory/2025-01-15T00-00-00Z/manifest.json
Start Time:          2025-01-15T00:00:00Z
End Time:            2025-01-15T00:02:34Z
Next Scheduled Time: 2025-01-22T00:00:00Z

All jobs table

The following example shows the output when using the --all flag:

$ mc inventory status --all myaistor
BUCKET       JOB ID              STATE      SCHEDULE  START TIME (UTC)     DURATION  MATCHED  ERRORS
mybucket     weekly-inventory    completed  weekly    2025-01-15 00:00:00  2m34s     10256    0
mybucket     daily-audit         running    daily     2025-01-16 00:00:00  1m12s     5432     0
data-lake    monthly-report      sleeping   monthly   2025-01-01 00:00:00  15m22s    125000   0
archive      yearly-compliance   scheduled  yearly    -                    -         0        0

Total jobs: 4

S3 compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested with AIStor 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.

Permissions

The user or service account running this command must have the s3:GetInventoryConfiguration permission for the specified bucket.

For more information on AIStor policies and permissions, see Access Management.

Behavior

Status information

The command displays comprehensive status information including:

  • JobID: The inventory configuration identifier
  • State: Current job state
  • Bucket: The source bucket being inventoried
  • User: The user or service account that created the configuration
  • Access Key: The access key used for execution
  • Schedule: The job schedule (once, hourly, daily, weekly, monthly, yearly)
  • Scanned Objects: Total size of objects scanned
  • Scanned Count: Total number of objects scanned
  • Matched Objects: Size of objects matching filters
  • Matched Count: Number of objects matching filters
  • Records Written: Number of records written to output files
  • Output Files: Number of output files generated
  • Execution Time: Duration of the current or last execution
  • Num Starts: Total number of times the job has executed
  • Manifest Path: Location of the manifest file for the current or last execution
  • Start Time: When the current or last execution started
  • End Time: When the last execution completed
  • Next Scheduled Time: When the job is scheduled to run next (periodic jobs only)
  • Last Fail Time: When the job last failed (if applicable)