Get Bucket Rate Limit
---------------------
-Get the current configured rate limit parameters
-For example::
+The ``radosgw-admin ratelimit get`` command returns the current configured rate
+limit parameters.
+
+The following is the general form of the command that returns the current
+configured limit parameters:
+
+.. prompt:: bash
- radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket=<bucket>
+ radosgw-admin ratelimit get --ratelimit-scope=bucket --bucket=<bucket>
-For example::
+An example of using ``radosgw-admin ratelimit get`` to return the rate limit
+parameters for a bucket might look like this:
- radosgw-admin ratelimit get --ratelimit-scope=bucket --bucket=mybucket
+.. prompt:: bash
+ radosgw-admin ratelimit get --ratelimit-scope=bucket --bucket=mybucket
-A 0 value for num ops and / or num bytes means that the
-specific rate limit attribute check is disabled.
+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 Bucket Rate Limit
- --------------------------------
+ Enable and Disable Bucket Rate Limit
+ ------------------------------------
+
+ After you set a bucket rate limit, you can enable it. The following is the
+ general form of the ``radosgw-admin ratelimit enable`` command that enables
+ bucket rate limits:
- Once you set a bucket rate limit, you may enable it. For example::
+ .. prompt:: bash
- radosgw-admin ratelimit enable --ratelimit-scope=bucket --bucket=<bucket>
+ radosgw-admin ratelimit enable --ratelimit-scope=bucket --bucket=<bucket>
- You may disable an enabled bucket rate limit. For example::
+ An enabled bucket rate limit can be disabled by running a command of the following form:
- radosgw-admin ratelimit disable --ratelimit-scope=bucket --uid=mybucket
+ .. prompt:: bash
+ radosgw-admin ratelimit disable --ratelimit-scope=bucket --uid=mybucket
Reading / Writing Global Rate Limit Configuration
-------------------------------------------------