From 0ef718b01e644b2b1af470d23e453760b25d00a6 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Thu, 11 Jan 2024 23:40:25 +1000 Subject: [PATCH] doc/radosgw: edit admin.rst "get user rate limit" Edit "Get User Rate Limit" in doc/radosgw/admin.rst. Signed-off-by: Zac Dover (cherry picked from commit 1c561e2beac67c85c40f2adf387c42aba8175ecb) --- doc/radosgw/admin.rst | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst index a178d69421fb2..57d38c97ab2ff 100644 --- a/doc/radosgw/admin.rst +++ b/doc/radosgw/admin.rst @@ -679,18 +679,26 @@ limit. Get User Rate Limit ------------------- -Get the current configured rate limit parameters -For example:: +The ``radosgw-admin ratelimit get`` command returns the current configured rate +limit parameters. - radosgw-admin ratelimit get --ratelimit-scope=user --uid= +The following is the general form of the command that returns the current +configured limit parameters: -For example:: +.. prompt:: bash - radosgw-admin ratelimit get --ratelimit-scope=user --uid=johndoe + radosgw-admin ratelimit get --ratelimit-scope=user --uid= +An example of using ``radosgw-admin ratelimit get`` to return the rate limit +parameters might look like this: -A 0 value for num ops and / or num bytes means that the -specific rate limit attribute check is disabled. +.. prompt:: bash + + radosgw-admin ratelimit get --ratelimit-scope=user --uid=johndoe + +A value of ``0`` assigned to ``--max-read-ops``, ``--max-read-bytes``, +``--max-write-ops``, or ``--max-write-bytes`` disables the specified rate +limit. Enable/Disable User Rate Limit -- 2.39.5