mirror of
https://github.com/minio/docs.git
synced 2025-08-06 14:42:56 +03:00
34cf55934a
mc RELEASE.2023-07-18T21-05-38Z - Replaces mc replicate diff with mc replicate backlog - Adds mc support top net mc RELEASE.2023-07-07T05-25-51Z - Adds mc support perf site-replication - Deprecates mc admin replicate --sync flag in favor of new mc admihn replicate --mode flag - Updates output example of mc admin user info to show authentication info Partially addresses #930
114 lines
2.5 KiB
ReStructuredText
114 lines
2.5 KiB
ReStructuredText
======================
|
|
``mc support top api``
|
|
======================
|
|
|
|
.. default-domain:: minio
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. mc:: mc support top api
|
|
|
|
.. include:: /includes/common-mc-support.rst
|
|
:start-after: start-minio-only
|
|
:end-before: end-minio-only
|
|
|
|
Syntax
|
|
------
|
|
|
|
.. start-mc-support-top-api-desc
|
|
|
|
The :mc:`mc support top api` command summarizes the real-time API events on a MinIO deployment server.
|
|
|
|
.. end-mc-support-top-api-desc
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: EXAMPLE
|
|
|
|
The following command displays the current in-progress S3 API calls on the :term:`alias` ``myminio``.
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc support top api myminio/
|
|
|
|
.. tab-item:: SYNTAX
|
|
|
|
The command has the following syntax:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc [GLOBALFLAGS] support top api \
|
|
TARGET \
|
|
[--name "string"] \
|
|
[--path "string"] \
|
|
[--node "string"] \
|
|
[--errors, -e]
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-syntax
|
|
:end-before: end-minio-syntax
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. mc-cmd:: TARGET
|
|
:required:
|
|
|
|
The full path to the alias, prefix, or object where the command should run.
|
|
The path must include at least an :ref:`ALIAS <minio-mc-alias>`.
|
|
|
|
.. mc-cmd:: --name
|
|
:optional:
|
|
|
|
Outputs a summary of current API calls matching the entered string.
|
|
|
|
|
|
.. mc-cmd:: --path
|
|
:optional:
|
|
|
|
Outputs a summary of current API calls for a specified path.
|
|
|
|
.. mc-cmd:: --node
|
|
:optional:
|
|
|
|
Outputs a summary of the current API calls on matching servers.
|
|
|
|
.. mc-cmd:: --errors, -e
|
|
:optional:
|
|
|
|
Outputs a summary of current API calls returning errors.
|
|
|
|
Global Flags
|
|
~~~~~~~~~~~~
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-mc-globals
|
|
:end-before: end-minio-mc-globals
|
|
|
|
Examples
|
|
--------
|
|
|
|
Display All Current In-progress S3 API Calls
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The following command displays all in-progress S3 calls for the ``myminio`` deployment:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
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:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc support top api --name s3.PutObject myminio/
|