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

   1 ====================
   2  Service Operations
   3 ====================
   4
   5 To retrieve data about our Swift-compatible service, you may execute ``GET``
   6 requests using the ``X-Storage-Url`` value retrieved during authentication.
   7
   8 List Containers
   9 ===============
  10
  11 A ``GET`` request that specifies the API version and the account will return
  12 a list of containers for a particular user account. Since the request returns
  13 a particular user's containers, the request requires an authentication token.
  14 The request cannot be made anonymously.
  15
  16 Syntax
  17 ~~~~~~
  18
  19 ::
  20
  21         GET /{api version}/{account} HTTP/1.1
  22         Host: {fqdn}
  23         X-Auth-Token: {auth-token}
  24
  25
  26
  27 Request Parameters
  28 ~~~~~~~~~~~~~~~~~~
  29
  30 ``limit``
  31
  32 :Description: Limits the number of results to the specified value.
  33 :Type: Integer
  34 :Required: No
  35
  36 ``format``
  37
  38 :Description: Defines the format of the result.
  39 :Type: String
  40 :Valid Values: ``json`` | ``xml``
  41 :Required: No
  42
  43
  44 ``marker``
  45
  46 :Description: Returns a list of results greater than the marker value.
  47 :Type: String
  48 :Required: No
  49
  50
  51
  52 Response Entities
  53 ~~~~~~~~~~~~~~~~~
  54
  55 The response contains a list of containers, or returns with an HTTP
  56 204 response code
  57
  58 ``account``
  59
  60 :Description: A list for account information.
  61 :Type: Container
  62
  63 ``container``
  64
  65 :Description: The list of containers.
  66 :Type: Container
  67
  68 ``name``
  69
  70 :Description: The name of a container.
  71 :Type: String
  72
  73 ``bytes``
  74
  75 :Description: The size of the container.
  76 :Type: Integer