mc support top api

Version changed

Beginning with AIStor Client RELEASE.2025-08-21T03-14-05Z, this command returns S3 call information gathered during the last minute.

Previously, the command returned information about in-progress S3 API calls gathered from mc admin trace.

The mc support top api command outputs the last minute of S3 API events on an AIStor server in real-time. The output is a high level summary of these calls. For more in-depth tracing, use mc admin trace.

At the initial command, the output includes information for API events in the minute prior to the command. The displayed output is always information about the last minute and continuously updates.

If output to JSON, the data accumulates continuously, gathering up to 24 hours of calls.

The information that returns for each API event includes:

  • Name
  • Count
  • Duration
  • Errors
  • Incoming and Outgoing size in bytes
  • Time to first byte (TTFB)
  • Max TTFB
  • Maximum and minimum event duration

Syntax

Parameters

TARGET

Required

The full path to the alias, prefix, or object where the command should run. The path must include at least an ALIAS.

--airgap

Run the command in an environment that does not have access to SUBNET

--by-host

Return results by host.

Requires the --json flag for outputting to JSON.

--errors

Alias: -e

Optional

Outputs a summary of current API calls returning errors.

--name

Optional

Outputs a summary of current API calls matching the specified API name. Enter multiple API names to match as a comma-separated list.

--nodes

Optional

Outputs a summary of the current API calls on matching servers. Specify one or more servers as a comma-separated list of FQDN or IP address and port.

Global flags

This command supports any of the global flags.

Examples

All current in-progress S3 API calls

The following command displays all in-progress S3 calls for the myaistor deployment:

mc support top api myaistor

Current in-progress s3.PutObject calls

The following command displays all in-progress s3.PutObject calls for the myaistor deployment:

mc support top api --name s3.PutObject myaistor