summaryrefslogtreecommitdiffstats
path: root/doc/radosgw/swift/serviceops.rst
blob: a00f3d80729108d75f0765fed7e8bcf0fdc9c769 (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
70
71
72
73
74
75
76
====================
 Service Operations
====================

To retrieve data about our Swift-compatible service, you may execute ``GET`` 
requests using the ``X-Storage-Url`` value retrieved during authentication. 

List Containers
===============

A ``GET`` request that specifies the API version and the account will return
a list of containers for a particular user account. Since the request returns
a particular user's containers, the request requires an authentication token.
The request cannot be made anonymously.

Syntax
~~~~~~

::

	GET /{api version}/{account} HTTP/1.1
	Host: {fqdn}
	X-Auth-Token: {auth-token}



Request Parameters
~~~~~~~~~~~~~~~~~~

``limit``

:Description: Limits the number of results to the specified value.
:Type: Integer
:Required: No

``format``

:Description: Defines the format of the result. 
:Type: String
:Valid Values: ``json`` | ``xml``
:Required: No


``marker``

:Description: Returns a list of results greater than the marker value.
:Type: String
:Required: No



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

The response contains a list of containers, or returns with an HTTP
204 response code

``account``

:Description: A list for account information.
:Type: Container

``container``

:Description: The list of containers.
:Type: Container

``name``

:Description: The name of a container.
:Type: String

``bytes``

:Description: The size of the container.
:Type: Integer