summaryrefslogtreecommitdiffstats
path: root/doc/radosgw/s3/serviceops.rst
blob: 54b6ca375113a32c5d594d4bb932b554d018b417 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
Service Operations
==================

List Buckets
------------
``GET /`` returns a list of buckets created by the user making the request. ``GET /`` only
returns buckets created by an authenticated user. You cannot make an anonymous request.

Syntax
~~~~~~
::

	GET / HTTP/1.1
	Host: cname.domain.com

	Authorization: AWS {access-key}:{hash-of-header-and-secret}

Response Entities
~~~~~~~~~~~~~~~~~

+----------------------------+-------------+-----------------------------------------------------------------+
| Name                       | Type        | Description                                                     |
+============================+=============+=================================================================+
| ``Buckets``                | Container   | Container for list of buckets.                                  |
+----------------------------+-------------+-----------------------------------------------------------------+
| ``Bucket``                 | Container   | Container for bucket information.                               |
+----------------------------+-------------+-----------------------------------------------------------------+
| ``Name``                   | String      | Bucket name.                                                    |
+----------------------------+-------------+-----------------------------------------------------------------+
| ``CreationDate``           | Date        | UTC time when the bucket was created.                           |
+----------------------------+-------------+-----------------------------------------------------------------+
| ``ListAllMyBucketsResult`` | Container   | A container for the result.                                     |
+----------------------------+-------------+-----------------------------------------------------------------+
| ``Owner``                  | Container   | A container for the bucket owner's ``ID`` and ``DisplayName``.  |
+----------------------------+-------------+-----------------------------------------------------------------+
| ``ID``                     | String      | The bucket owner's ID.                                          |
+----------------------------+-------------+-----------------------------------------------------------------+
| ``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                                            |
+----------------------------+-------------+-----------------------------------------------------------------+