From e02b84589e0f84d2deaefcdb482a8de4d737f211 Mon Sep 17 00:00:00 2001 From: John Wilkins Date: Mon, 14 Apr 2014 09:15:20 -0700 Subject: [PATCH] doc: Admin API usage for quotas. Needs additional clarification on syntax. Signed-off-by: John Wilkins --- doc/radosgw/adminops.rst | 55 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/doc/radosgw/adminops.rst b/doc/radosgw/adminops.rst index 3da27ea3a4483..a01c797fce8f8 100644 --- a/doc/radosgw/adminops.rst +++ b/doc/radosgw/adminops.rst @@ -1812,6 +1812,61 @@ Special Error Responses None. +Quotas +====== + +.. todo:: Need clarification on syntax. + + +The Admin Operations API enables you to set quotas on users and buckets. +Quotas include the maximum number of objects in a bucket and the maximum +storage size in megabytes. + +To view quotas, the user must have a ``users=read`` capability. To set, +modify or disable a quota, the user must have ``users=write`` capability. +See the `Admin Guide`_ for details. + + +Valid parameters for quotas include: + +- **Bucket:** The ``bucket`` option allows you to specify a quota for + a particular bucket. + +- **Maximum Objects:** The ``max-objects`` setting allows you to specify + the maximum number of objects. A negative value disables this setting. + +- **Maximum Size:** The ``max-size`` option allows you to specify a quota + for the maximum number of bytes. A negative value disables this setting. + +- **Quota Scope:** The ``quota-scope`` option sets the scope for the quota. + The options are ``bucket`` and ``user``. + + + +Read User Quota +--------------- + +Read user quota setting + + - requires the 'users' read cap set. + +GET /admin/user?quota&uid=["a-type=] + + +Modify User Quota +----------------- + + + - requires the 'users' write cap set + +PUT /admin/user?quota&uid=["a-type=] + +Content should include a json representation of the quota settings +(either the user quota, or the bucket quota, or both) as encoded in +the corresponding read operation. + + + Standard Error Responses ======================== -- 2.39.5