Skip to content

Commit a6110a8

Browse files
Merge pull request ceph#55146 from zdover23/wip-doc-2024-01-11-radosgw-get-user-rate-limit
doc/radosgw: edit admin.rst "get user rate limit"
2 parents f14f60a + 1c561e2 commit a6110a8

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

doc/radosgw/admin.rst

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -671,18 +671,26 @@ specific rate limit attribute check is disabled.
671671
Get User Rate Limit
672672
-------------------
673673

674-
Get the current configured rate limit parameters
675-
For example::
674+
The ``radosgw-admin ratelimit get`` command returns the current configured rate
675+
limit parameters.
676676

677-
radosgw-admin ratelimit get --ratelimit-scope=user --uid=<uid>
677+
The following is the general form of the command that returns the current
678+
configured limit parameters:
678679

679-
For example::
680+
.. prompt:: bash
680681

681-
radosgw-admin ratelimit get --ratelimit-scope=user --uid=johndoe
682+
radosgw-admin ratelimit get --ratelimit-scope=user --uid=<uid>
682683

684+
An example of using ``radosgw-admin ratelimit get`` to return the rate limit
685+
parameters might look like this:
683686

684-
A 0 value for num ops and / or num bytes means that the
685-
specific rate limit attribute check is disabled.
687+
.. prompt:: bash
688+
689+
radosgw-admin ratelimit get --ratelimit-scope=user --uid=johndoe
690+
691+
A value of ``0`` assigned to ``--max-read-ops``, ``--max-read-bytes``,
692+
``--max-write-ops``, or ``--max-write-bytes`` disables the specified rate
693+
limit.
686694

687695

688696
Enable/Disable User Rate Limit

0 commit comments

Comments
 (0)