RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-04-01 23:02:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

rgw: s3: document usage stats api

Browse Source 
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
This commit is contained in:
Abhishek Lekshmanan 2020-02-25 19:10:55 +01:00
parent dbdf49ec28
commit b5f24c9f14
2 changed files with 31 additions and 0 deletions

1
doc/radosgw/admin.rst
View File

@ -415,6 +415,7 @@ the latest quota stats. ::
radosgw-admin user stats --uid=<uid> --sync-stats
.. _rgw_user_usage_stats:
Get User Usage Stats
--------------------

30
doc/radosgw/s3/serviceops.rst
View File

@ -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 |
+----------------------------+-------------+-----------------------------------------------------------------+