`mc support top api`

SUBNET Registration Required

The mc support commands are designed for MinIO deployments registered with MinIO SUBNET to ensure optimal outcome of diagnostics and performance testing. Deployments not registered with SUBNET cannot use the mc support commands.

Syntax

The mc support top api command summarizes the real-time API events on a MinIO deployment server.

EXAMPLE

The following command displays the current in-progress S3 API calls on the alias myminio.

mc support top api myminio/

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] support top api    \
                 TARGET             \
                 [--name "string"]  \
                 [--path "string"]  \
                 [--node "string"]  \
                 [--errors, -e]

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.

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.

--name: Optional
Outputs a summary of current API calls matching the entered string.

--path: Optional
Outputs a summary of current API calls for a specified path.

--node: Optional
Outputs a summary of the current API calls on matching servers.

--errors, -e: Optional
Outputs a summary of current API calls returning errors.

Global Flags

This command supports any of the global flags.

Examples

Display All Current In-progress S3 API Calls

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

mc support top api myminio/

Display Current, In-progress `s3.PutObject` Calls

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

mc support top api --name s3.PutObject myminio/