diff options
| author | Casey Bodley <cbodley@users.noreply.github.com> | 2020-02-28 15:31:14 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-28 15:31:14 +0100 |
| commit | 3064f2022029fb2a63802316d8c97dfdae3b2337 (patch) | |
| tree | fe7ba4694e8b394c0bcdc4198a72aef1ee2ca3af /doc/radosgw | |
| parent | Merge pull request #33527 from alimaredia/wip-rgw-realm-pull-log-msg (diff) | |
| parent | examples: add python source for append & get_usage_stats (diff) | |
| download | ceph-3064f2022029fb2a63802316d8c97dfdae3b2337.tar.xz ceph-3064f2022029fb2a63802316d8c97dfdae3b2337.zip | |
Merge pull request #33063 from theanalyst/boto3-ext-append
examples: rgw: add boto3 append & get usage api extensions
Reviewed-by: Yuval Lifshitz <yuvalif@yahoo.com>
Diffstat (limited to 'doc/radosgw')
| -rw-r--r-- | doc/radosgw/admin.rst | 1 | ||||
| -rw-r--r-- | doc/radosgw/s3/serviceops.rst | 30 |
2 files changed, 31 insertions, 0 deletions
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 | ++----------------------------+-------------+-----------------------------------------------------------------+ |