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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
|
==================
Admin Operations
==================
An admin API request will be done on a URI that starts with the configurable 'admin'
resource entry point. Authorization for the admin API duplicates the S3 authorization
mechanism. Some operations require that the user holds special administrative capabilities.
The response entity type (XML or JSON) may be specified as the 'format' option in the
request and defaults to JSON if not specified.
Get Object
==========
Get an existing object. NOTE: Does not require owner to be non-suspended.
Syntax
~~~~~~
::
GET /{admin}/bucket?object&format=json HTTP/1.1
Host {fqdn}
Request Parameters
~~~~~~~~~~~~~~~~~~
``bucket``
:Description: The bucket containing the object to be retrieved.
:Type: String
:Example: ``foo_bucket``
:Required: Yes
``object``
:Description: The object to be retrieved.
:Type: String
:Example: ``foo.txt``
:Required: Yes
Response Entities
~~~~~~~~~~~~~~~~~
If successful, returns the desired object.
``object``
:Description: The desired object.
:Type: Object
Special Error Responses
~~~~~~~~~~~~~~~~~~~~~~~
``NoSuchObject``
:Description: Specified object does not exist.
:Code: 404 Not Found
Head Object
===========
Verify the existence of an object. If the object exists,
metadata headers for the object will be returned.
Syntax
~~~~~~
::
HEAD /{admin}/bucket?object HTTP/1.1
Host {fqdn}
Request Parameters
~~~~~~~~~~~~~~~~~~
``bucket``
:Description: The bucket containing the object to be retrieved.
:Type: String
:Example: ``foo_bucket``
:Required: Yes
``object``
:Description: The object to be retrieved.
:Type: String
:Example: ``foo.txt``
:Required: Yes
Response Entities
~~~~~~~~~~~~~~~~~
None.
Special Error Responses
~~~~~~~~~~~~~~~~~~~~~~~
``NoSuchObject``
:Description: Specified object does not exist.
:Code: 404 Not Found
Get Zone Info
=============
Get cluster information.
Syntax
~~~~~~
::
GET /{admin}/zone&format=json HTTP/1.1
Host {fqdn}
Response Entities
~~~~~~~~~~~~~~~~~
If successful, returns cluster pool configuration.
``zone``
:Description: Contains current cluster pool configuration.
:Type: Container
``domain_root``
:Description: root of all buckets.
:Type: String
:Parent: ``cluster``
``control_pool``
:Description:
:Type: String
:Parent: ``cluster``
``gc_pool``
:Description: Garbage collection pool.
:Type: String
:Parent: ``cluster``
``log_pool``
:Description: Log pool.
:Type: String
:Parent: ``cluster``
``intent_log_pool``
:Description: Intent log pool.
:Type: String
:Parent: ``cluster``
``usage_log_pool``
:Description: Usage log pool.
:Type: String
:Parent: ``cluster``
``user_keys_pool``
:Description: User key pool.
:Type: String
:Parent: ``cluster``
``user_email_pool``
:Description: User email pool.
:Type: String
:Parent: ``cluster``
``user_swift_pool``
:Description: Pool of swift users.
:Type: String
:Parent: ``cluster``
Special Error Responses
~~~~~~~~~~~~~~~~~~~~~~~
None.
Example Response
~~~~~~~~~~~~~~~~
::
HTTP/1.1 200
Content-Type: application/json
{
"domain_root": ".rgw",
"control_pool": ".rgw.control",
"gc_pool": ".rgw.gc",
"log_pool": ".log",
"intent_log_pool": ".intent-log",
"usage_log_pool": ".usage",
"user_keys_pool": ".users",
"user_email_pool": ".users.email",
"user_swift_pool": ".users.swift",
"user_uid_pool ": ".users.uid"
}
Add Placement Pool
==================
Make a pool available for data placement.
Syntax
~~~~~~
::
PUT /{admin}/pool?format=json HTTP/1.1
Host {fqdn}
Request Parameters
~~~~~~~~~~~~~~~~~~
``pool``
:Description: The pool to be made available for data placement.
:Type: String
:Example: ``foo_pool``
:Required: Yes
``create``
:Description: Creates the data pool if it does not exist.
:Type: Boolean
:Example: False [False]
:Required: No
Response Entities
~~~~~~~~~~~~~~~~~
TBD.
Special Error Responses
~~~~~~~~~~~~~~~~~~~~~~~
TBD.
Remove Placement Pool
=====================
Make a pool unavailable for data placement.
Syntax
~~~~~~
::
DELETE /{admin}/pool?format=json HTTP/1.1
Host {fqdn}
Request Parameters
~~~~~~~~~~~~~~~~~~
``pool``
:Description: The existing pool to be made available for data placement.
:Type: String
:Example: ``foo_pool``
:Required: Yes
``destroy``
:Description: Destroys the pool after removing it from the active set.
:Type: Boolean
:Example: False [False]
:Required: No
Response Entities
~~~~~~~~~~~~~~~~~
TBD.
Special Error Responses
~~~~~~~~~~~~~~~~~~~~~~~
TBD.
List Available Data Placement Pools
===================================
List current pools available for data placement.
Syntax
~~~~~~
::
GET /{admin}/pool?format=json HTTP/1.1
Host {fqdn}
Response Entities
~~~~~~~~~~~~~~~~~
If successful, returns a list of pools available for data placement.
``pools``
:Description: Contains currently available pools for data placement.
:Type: Container
List Expired Garbage Collection Items
=====================================
List objects scheduled for garbage collection.
Syntax
~~~~~~
::
GET /{admin}/garbage?format=json HTTP/1.1
Host {fqdn}
Request Parameters
~~~~~~~~~~~~~~~~~~
None.
Response Entities
~~~~~~~~~~~~~~~~~
If expired garbage collection items exist, a list of such objects
will be returned.
``garbage``
:Description: Expired garbage collection items.
:Type: Container
``object``
:Description: A container garbage collection object information.
:Type: Container
:Parent: ``garbage``
``name``
:Description: The name of the object.
:Type: String
:Parent: ``object``
``expired``
:Description: The date at which the object expired.
:Type: String
:Parent: ``object``
Special Error Responses
~~~~~~~~~~~~~~~~~~~~~~~
TBD.
Manually Processes Garbage Collection Items
===========================================
List objects scheduled for garbage collection.
Syntax
~~~~~~
::
DELETE /{admin}/garbage?format=json HTTP/1.1
Host {fqdn}
Request Parameters
~~~~~~~~~~~~~~~~~~
None.
Response Entities
~~~~~~~~~~~~~~~~~
If expired garbage collection items exist, a list of removed objects
will be returned.
``garbage``
:Description: Expired garbage collection items.
:Type: Container
``object``
:Description: A container garbage collection object information.
:Type: Container
:Parent: ``garbage``
``name``
:Description: The name of the object.
:Type: String
:Parent: ``object``
``expired``
:Description: The date at which the object expired.
:Type: String
:Parent: ``object``
Special Error Responses
~~~~~~~~~~~~~~~~~~~~~~~
TBD.
Show Log Objects
================
Show log objects
Syntax
~~~~~~
::
GET /{admin}/log?format=json HTTP/1.1
Host {fqdn}
Request Parameters
~~~~~~~~~~~~~~~~~~
``object``
:Description: The log object to return.
:Type: String:
:Example: ``2012-10-11-09-4165.2-foo_bucket``
:Required: No
Response Entities
~~~~~~~~~~~~~~~~~
If no object is specified, returns the full list of log objects.
``log-objects``
:Description: A list of log objects.
:Type: Container
``object``
:Description: The name of the log object.
:Type: String
``log``
:Description: The contents of the log object.
:Type: Container
Special Error Responses
~~~~~~~~~~~~~~~~~~~~~~~
None.
Standard Error Responses
========================
``AccessDenied``
:Description: Access denied.
:Code: 403 Forbidden
``InternalError``
:Description: Internal server error.
:Code: 500 Internal Server Error
``NoSuchUser``
:Description: User does not exist.
:Code: 404 Not Found
``NoSuchBucket``
:Description: Bucket does not exist.
:Code: 404 Not Found
``NoSuchKey``
:Description: No such access key.
:Code: 404 Not Found
|
