From: Abhishek Lekshmanan <abhishek@suse.com>
Date: Tue, 25 Feb 2020 18:10:55 +0000 (+0100)
Subject: rgw: s3: document usage stats api
X-Git-Tag: v15.1.1~200^2~2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=b5f24c9f14652e40adb4812586faa530feab8dc1;p=ceph.git

rgw: s3: document usage stats api

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
---

diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst
index 42e3d97bd44..4f172eab4aa 100644
--- a/doc/radosgw/admin.rst
+++ b/doc/radosgw/admin.rst
@@ -415,6 +415,7 @@ the latest quota stats. ::
 
 	radosgw-admin user stats --uid=<uid> --sync-stats
 
+.. _rgw_user_usage_stats:
 
 Get User Usage Stats
 --------------------
diff --git a/doc/radosgw/s3/serviceops.rst b/doc/radosgw/s3/serviceops.rst
index c55ce988bd1..54b6ca37511 100644
--- a/doc/radosgw/s3/serviceops.rst
+++ b/doc/radosgw/s3/serviceops.rst
@@ -37,3 +37,33 @@ Response Entities
 +----------------------------+-------------+-----------------------------------------------------------------+
 | ``DisplayName``            | String      | The bucket owner's display name.                                |
 +----------------------------+-------------+-----------------------------------------------------------------+
+
+
+Get Usage Stats
+---------------
+
+Gets usage stats per user, similar to the admin command :ref:`rgw_user_usage_stats`.
+
+Syntax
+~~~~~~
+::
+
+	GET /?usage HTTP/1.1
+	Host: cname.domain.com
+
+	Authorization: AWS {access-key}:{hash-of-header-and-secret}
+
+Response Entities
+~~~~~~~~~~~~~~~~~
+
++----------------------------+-------------+-----------------------------------------------------------------+
+| Name                       | Type        | Description                                                     |
++============================+=============+=================================================================+
+| ``Summary``                | Container   | Summary of total stats by user.                                 |
++----------------------------+-------------+-----------------------------------------------------------------+
+| ``TotalBytes``             | Integer     | Bytes used by user                                              |
++----------------------------+-------------+-----------------------------------------------------------------+
+| ``TotalBytesRounded``      | Integer     | Bytes rounded to the nearest 4k boundary                        |
++----------------------------+-------------+-----------------------------------------------------------------+
+| ``TotalEntries``           | Integer     | Total object entries                                            |
++----------------------------+-------------+-----------------------------------------------------------------+