src/ceph/doc/radosgw/s3/serviceops.rst

   1 Service Operations
   2 ==================
   3
   4 List Buckets
   5 ------------
   6 ``GET /`` returns a list of buckets created by the user making the request. ``GET /`` only
   7 returns buckets created by an authenticated user. You cannot make an anonymous request.
   8
   9 Syntax
  10 ~~~~~~
  11 ::
  12
  13         GET / HTTP/1.1
  14         Host: cname.domain.com
  15
  16         Authorization: AWS {access-key}:{hash-of-header-and-secret}
  17
  18 Response Entities
  19 ~~~~~~~~~~~~~~~~~
  20
  21 +----------------------------+-------------+-----------------------------------------------------------------+
  22 | Name                       | Type        | Description                                                     |
  23 +============================+=============+=================================================================+
  24 | ``Buckets``                | Container   | Container for list of buckets.                                  |
  25 +----------------------------+-------------+-----------------------------------------------------------------+
  26 | ``Bucket``                 | Container   | Container for bucket information.                               |
  27 +----------------------------+-------------+-----------------------------------------------------------------+
  28 | ``Name``                   | String      | Bucket name.                                                    |
  29 +----------------------------+-------------+-----------------------------------------------------------------+
  30 | ``CreationDate``           | Date        | UTC time when the bucket was created.                           |
  31 +----------------------------+-------------+-----------------------------------------------------------------+
  32 | ``ListAllMyBucketsResult`` | Container   | A container for the result.                                     |
  33 +----------------------------+-------------+-----------------------------------------------------------------+
  34 | ``Owner``                  | Container   | A container for the bucket owner's ``ID`` and ``DisplayName``.  |
  35 +----------------------------+-------------+-----------------------------------------------------------------+
  36 | ``ID``                     | String      | The bucket owner's ID.                                          |
  37 +----------------------------+-------------+-----------------------------------------------------------------+
  38 | ``DisplayName``            | String      | The bucket owner's display name.                                |
  39 +----------------------------+-------------+-----------------------------------------------------------------+