]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw: edit admin.rst "get user rate limit" 55158/head
authorZac Dover <zac.dover@proton.me>
Thu, 11 Jan 2024 13:40:25 +0000 (23:40 +1000)
committerZac Dover <zac.dover@proton.me>
Fri, 12 Jan 2024 03:28:54 +0000 (13:28 +1000)
Edit "Get User Rate Limit" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 1c561e2beac67c85c40f2adf387c42aba8175ecb)

doc/radosgw/admin.rst

index a178d69421fb2a4dd7b95055ec522e4a12100b65..57d38c97ab2fffbd4a22e8117d35c771097846f7 100644 (file)
@@ -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=<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=<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