frugalos 1.2.0

Frugal Object Storage
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
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513

<!DOCTYPE html><html><head><meta charset="utf-8"><title>バケツAPI (Version 1)</title><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@import url('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby .hljs-constant,.xml .hljs-tag .hljs-title,.xml .hljs-pi,.xml .hljs-doctype,.html .hljs-doctype,.css .hljs-id,.css .hljs-class,.css .hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby .hljs-class .hljs-title,.css .hljs-rules .hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.hljs-function,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword,.perl .hljs-sub,.javascript .hljs-title,.coffeescript .hljs-title{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .javascript,.xml .vbscript,.xml .css,.xml .hljs-cdata{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}body{color:black;background:white;font:400 14px / 1.42 'Roboto',Helvetica,sans-serif}header{border-bottom:1px solid #f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:black;margin:12px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}.triple h1 .permalink,.triple h2 .permalink,.triple h3 .permalink,.triple h4 .permalink,.triple h5 .permalink{opacity:.15}.triple h1:hover .permalink,.triple h2:hover .permalink,.triple h3:hover .permalink,.triple h4:hover .permalink,.triple h5:hover .permalink{opacity:.15}h1{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:36px}h2{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12px auto;background-image:linear-gradient(to right, rgba(0,0,0,0) 20%, rgba(0,0,0,0.2) 51.4%, rgba(255,255,255,0.2) 51.4%, rgba(255,255,255,0) 80%)}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px}blockquote{color:rgba(0,0,0,0.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #e8e8e8}blockquote p:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1px solid #cfcfcf;border-radius:6px;overflow:auto}pre code{color:black;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:'Inconsolata',monospace;padding:1px 4px;border:1px solid #cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}table tr:nth-child(2n){background-color:#fafafa}table th,table td{padding:6px 12px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:2px;font-size:90%}.note h1,.warning h1,.note h2,.warning h2,.note h3,.warning h3,.note h4,.warning h4,.note h5,.warning h5,.note h6,.warning h6{font-family:200 36px 'Raleway',Helvetica,sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:black;background-color:#f0f6fb;border-left:4px solid #428bca}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#428bca}.warning{color:black;background-color:#fbf1f0;border-left:4px solid #c9302c}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav .resource-group{padding:0}nav .resource-group .heading{position:relative}nav .resource-group .heading .chevron{position:absolute;top:12px;right:12px;opacity:.5}nav .resource-group .heading a{display:block;color:black;opacity:.7;border-left:2px solid transparent;margin:0}nav .resource-group .heading a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(0,0,0,0.7);padding:8px 12px;border-top:1px solid #d9d9d9;border-left:2px solid transparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-12px}nav ul>li:last-child{margin-bottom:-12px}nav ul ul a{padding-left:24px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload *{transition:none !important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px 7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px 0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button .close{display:none;color:#428bca;cursor:pointer}.collapse-button .open{color:#428bca;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container .row .content{margin-left:244px;width:696px}.container .row:after{content:'';display:block;clear:both}.container-fluid nav{width:22%}.container-fluid .row .content{margin-left:24%}.container-fluid.triple nav{width:16.5%;padding-right:1px}.container-fluid.triple .row .content{position:relative;margin-left:16.5%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.right a{color:#428bca}.right h1,.right h2,.right h3,.right h4,.right h5,.right p,.right div{color:white}.right pre{background-color:#1d1f21;border:1px solid #1d1f21}.right pre code{color:#c5c8c6}.right .description{margin-top:12px}.triple .resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition .method{font-weight:bold}.definition .method.get{color:#2e8ab8}.definition .method.head{color:#2e8ab8}.definition .method.options{color:#2e8ab8}.definition .method.post{color:#56b82e}.definition .method.put{color:#b8a22e}.definition .method.patch{color:#b8a22e}.definition .method.delete{color:#b82e2e}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names .tab-button{cursor:pointer;color:black;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#444}.right .example-names .tab-button{color:white;border:1px solid #666;border-radius:6px}.right .example-names .tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1px solid #f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:224px;width:606px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:194px;width:526px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(0,0,0,0.5);background-color:#f2f2f2;text-decoration:none !important;border-top:1px solid #d9d9d9;border-left:1px solid #d9d9d9;border-right:1px solid #d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:white;border:1px solid #d9d9d9;border-radius:6px}.resource-group h2.group-heading,.resource-group .heading a{padding:12px;margin:-12px -12px 12px -12px;background-color:#f2f2f2;border-bottom:1px solid #d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple .content .resource-group{padding:0;border:none}.triple .content .resource-group h2.group-heading,.triple .content .resource-group .heading a{margin:0 0 12px 0;border:1px solid #d9d9d9}nav .resource-group .heading a{padding:12px;margin-bottom:0}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:12px;padding:12px 12px 0 12px;overflow:hidden;border:1px solid transparent;border-radius:6px}.action h4.action-heading{padding:6px 12px;margin:-12px -12px 12px -12px;border-bottom:1px solid transparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.action h4.action-heading .name{float:right;font-weight:normal;padding:6px 0}.action h4.action-heading .method{padding:6px 12px;margin-right:12px;border-radius:3px;display:inline-block}.action h4.action-heading .method.get{color:#fff;background-color:#337ab7}.action h4.action-heading .method.head{color:#fff;background-color:#337ab7}.action h4.action-heading .method.options{color:#fff;background-color:#337ab7}.action h4.action-heading .method.put{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.patch{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.post{color:#fff;background-color:#5cb85c}.action h4.action-heading .method.delete{color:#fff;background-color:#d9534f}.action h4.action-heading code{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.action dl.inner{padding-bottom:2px}.action .title{border-bottom:1px solid white;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#bce8f1}.action.get h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.head h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.options h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.post h4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.put h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patch h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.delete h4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style></head><body class="preload"><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i>&nbsp;Back to top</a><div class="container"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#top">Overview</a></div><div class="collapse-content"><ul><li><a href="#header-用語">用語</a></li><li><a href="#header-共通仕様">共通仕様</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#バケツ">バケツ</a></div><div class="collapse-content"><ul><li><a href="#バケツ-バケツ一覧-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>バケツ一覧の取得</a></li><li><a href="#バケツ-バケツ操作">バケツ操作</a><ul><li><a href="#バケツ-バケツ操作-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>バケツ構成の取得</a></li><li><a href="#バケツ-バケツ操作-put"><span class="badge put"><i class="fa fa-pencil"></i></span>バケツの作成・更新</a></li><li><a href="#バケツ-バケツ操作-delete"><span class="badge delete"><i class="fa fa-times"></i></span>バケツの削除（未実装）</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#オブジェクト">オブジェクト</a></div><div class="collapse-content"><ul><li><a href="#オブジェクト-オブジェクト操作">オブジェクト操作</a><ul><li><a href="#オブジェクト-オブジェクト操作-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>オブジェクトの取得</a></li><li><a href="#オブジェクト-オブジェクト操作-head"><span class="badge head"><i class="fa fa-info-circle"></i></span>オブジェクトの存在確認</a></li><li><a href="#オブジェクト-オブジェクト操作-put"><span class="badge put"><i class="fa fa-pencil"></i></span>オブジェクトの作成・更新</a></li><li><a href="#オブジェクト-オブジェクト操作-delete"><span class="badge delete"><i class="fa fa-times"></i></span>オブジェクトの削除</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#オブジェクトプレフィックス">オブジェクトプレフィックス</a></div><div class="collapse-content"><ul><li><a href="#オブジェクトプレフィックス-プレフィックス指定でのオブジェクト操作-delete"><span class="badge delete"><i class="fa fa-times"></i></span>オブジェクトの削除</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#セグメント">セグメント</a></div><div class="collapse-content"><ul><li><a href="#セグメント-セグメント一覧-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>セグメント一覧の取得</a></li><li><a href="#セグメント-セグメント操作-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>セグメント構成の取得(未実装)</a></li><li><a href="#セグメント-オブジェクト一覧-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>オブジェクト一覧の取得</a></li></ul></div></div><p style="text-align: center; word-wrap: break-word;"><a href="http://example.com">http://example.com</a></p></nav><div class="content"><header><h1 id="top">バケツAPI (Version 1)</h1></header><p>バケツ関連の操作を提供するAPI。</p>
<h2 id="header-用語">用語 <a class="permalink" href="#header-用語" aria-hidden="true">¶</a></h2>
<p><strong>サーバ:</strong></p>
<ul>
<li>
<p><code>frugalos</code>プロセスのこと</p>
</li>
<li>
<p>各サーバは、クラスタ内で一意なIDを有している</p>
</li>
</ul>
<p><strong>バケツ:</strong></p>
<ul>
<li>
<p><strong>バケツ</strong>とは、オブジェクト群を格納するための入れ物</p>
</li>
<li>
<p>オブジェクトの名前空間は、バケツ毎に異なる</p>
</li>
<li>
<p>冗長化方式等の設定は、バケツ毎に異なるものを設定可能</p>
</li>
<li>
<p>バケツ内の領域は、作成時に指定された数の<strong>セグメント</strong>に(論理的に)分割されている</p>
</li>
<li>
<p>一つのバケツには、一つの<strong>デバイス</strong>が対応する</p>
<ul>
<li>オブジェクト群は、そのデバイスに格納される</li>
<li>デバイスに関する詳細は <a href="./devices.html">デバイスAPI</a> を参照のこと</li>
</ul>
</li>
<li>
<p>なお<code>__system</code>という名前のバケツが、システム用に予約されている(i.e., 最初から存在し削除は不可)</p>
</li>
</ul>
<p><strong>セグメント:</strong></p>
<ul>
<li>
<p>バケツの論理的な分割単位</p>
</li>
<li>
<p>セグメント数は、バケツ作成時に指定されて、その後変更は不可</p>
</li>
<li>
<p>一つのバケツは、典型的には千個程度のセグメントに分割される</p>
</li>
<li>
<p>オブジェクト一覧を取得したい場合を除いて、基本的には利用者が意識する必要はない</p>
</li>
</ul>
<p><strong>オブジェクト:</strong></p>
<ul>
<li>
<p>オブジェクトとは、<strong>ID</strong>とそれに対応する<strong>内容</strong>、および<strong>バージョン</strong>から構成されるデータ</p>
</li>
<li>
<p>あるオブジェクトは、いずれかのバケツに格納され、そのIDはバケツ内で一意である</p>
</li>
<li>
<p>あるオブジェクトのバージョンは、保存(PUT)毎に自動で割り当てられ、その値は単調増加することが保証されている</p>
<ul>
<li>値が1ずつ増加する保証はない</li>
<li>このバージョンの値を利用することで、いわゆるCAS(Compare And Swap)的な操作が可能となる</li>
</ul>
</li>
<li>
<p>オブジェクトの内容としては、任意のバイト列を格納可能</p>
<ul>
<li>ただし、構成・設定に応じて、最大サイズには上限が設けられる</li>
<li>具体的な上限は設定に依存するが、通常は数十MB程度となる</li>
<li><strong>TODO: 使用しているバケツでの上限は <a href="TODO">TODO</a> のAPIを叩くことで取得可能</strong></li>
</ul>
</li>
</ul>
<p><strong>オブジェクトプレフィックス:</strong></p>
<ul>
<li>
<p>バケツに登録されているオブジェクトに付与されている<strong>ID</strong>の接頭辞</p>
</li>
<li>
<p>接頭辞であるので、あるオブジェクトに対してオブジェクトプレフィックスは複数存在する</p>
<ul>
<li>例えば lv12 のオブジェクトプレフィックスは l, lv, lv1, lv12 となる</li>
</ul>
</li>
</ul>
<p><strong>デッドライン:</strong></p>
<ul>
<li>
<p>オブジェクト関連の操作では、その完了までに要する時間の期待上限値が指定可能である</p>
<ul>
<li>この値のことを<strong>デッドライン</strong>と呼称する</li>
</ul>
</li>
<li>
<p>デッドラインが指定された操作は、極力その時間内で実行が完了するようにスケジューリングされる</p>
</li>
<li>
<p>ただし、その時間内で確実に完了する保証はなく、またそれを超過したからといって実行が中断されることもない</p>
<ul>
<li>つまり一種の優先度的な値</li>
</ul>
</li>
<li>
<p>即時に実行する必要がない操作に関しては、デッドラインを長めに指定することで、他のより緊急度の高い操作を優先されることが可能</p>
</li>
</ul>
<p><strong>デバイス:</strong></p>
<ul>
<li>
<p>オブジェクト群の物理的な格納先</p>
</li>
<li>
<p>デバイスには大別して <strong>物理デバイス</strong> と <strong>仮想デバイス</strong> の二種類が存在する</p>
</li>
<li>
<p>物理デバイス:</p>
<ul>
<li>HDDやSSD等の物理的なデバイス</li>
<li>各物理デバイスは、特定の <strong>サーバ</strong> に属する</li>
<li>物理デバイスの種別は、その実体に応じて<code>memory</code>や<code>monofile</code>といったようにさらに細分化される</li>
</ul>
</li>
<li>
<p>仮想デバイス (<code>type=virtual</code>):</p>
<ul>
<li>物理デバイスをグルーピングする仮想的なデバイス</li>
<li>「マシン」、「ラック」、「データセンタ」といった単位は仮想デバイスを用いて表現する</li>
</ul>
</li>
<li>
<p><code>type=memory</code>:</p>
<ul>
<li>全てのオブジェクトをメモリ上に保持する</li>
</ul>
</li>
<li>
<p><code>type=monofile</code>:</p>
<ul>
<li>オブジェクト群を単一ファイル上に保持する</li>
</ul>
</li>
<li>
<p>サーバが保持するオブジェクト群を物理的に保持するための装置</p>
<ul>
<li>e.g., HDD, SSD</li>
</ul>
</li>
<li>
<p>各サーバへのデバイスの追加は<a href="https://frugalos.github.io/frugalos/v1/devices.html">デバイスAPI</a>経由で行う</p>
</li>
</ul>
<p><strong>重み (Weight):</strong></p>
<ul>
<li>
<p>デバイスをセグメントに割り当てる際の重み</p>
</li>
<li>
<p>各デバイスは、この値に比例した数のセグメントを担当することになる</p>
</li>
<li>
<p>デフォルト値は、デバイスの種別によって異なる:</p>
<ul>
<li><code>memory</code>: 1</li>
<li><code>monofile</code>: <code>capacity_gb</code>の値</li>
<li><code>virtual</code>: <code>children</code>の重みの合計値</li>
</ul>
</li>
</ul>
<p><strong>デバイスの無効化:</strong></p>
<ul>
<li>
<p><code>enable</code>フラグを<code>false</code>に設定することで、一時的にそのデバイスの使用を停止することができる</p>
</li>
<li>
<p>これは機能的にはデバイスの削除と似ているが、以下の点が異なる:</p>
<ul>
<li>デバイスが無効化された場合には、そのデバイスが担当していたセグメント群のみを、他のデバイス群が肩代わりする
<ul>
<li>つまり、データの移動は発生するが、その量は最小限で済む</li>
<li>=&gt; 短期的に取り外しているだけなら、こちらの方が良い</li>
</ul>
</li>
<li>逆に、デバイスを削除した場合には、クラスタ全体でのセグメント群の割り当てが最適化されるように割振りの調整が行われる
<ul>
<li>つまり、データの移動量は若干増えるが、それが完了した後のバランスぐらいは最適なものとなる</li>
<li>=&gt; 永続的に削除するなら、こちらの方が良い</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 id="header-共通仕様">共通仕様 <a class="permalink" href="#header-共通仕様" aria-hidden="true">¶</a></h2>
<p><strong>エラー時の応答:</strong></p>
<ul>
<li>
<p>エラー時の応答形式は<a href="https://tools.ietf.org/html/rfc7807">RFC 7807</a>に準拠する</p>
</li>
<li>
<p>各エンドポイントで固有の意味を持つ応答ステータスコードに関しては、この文書内で明示的に定義している</p>
</li>
<li>
<p>それ以外のエラー応答に関しては、HTTPの一般的なセマンティクスに従い、この文書内で定義することはしない</p>
<ul>
<li>e.g., 応答ステータスが<code>500</code>なら、サーバ内部エラー</li>
</ul>
</li>
</ul>
<section id="バケツ" class="resource-group"><h2 class="group-heading">バケツ <a href="#バケツ" class="permalink">&para;</a></h2><div id="バケツ-バケツ一覧" class="resource"><h3 class="resource-heading">バケツ一覧 <a href="#バケツ-バケツ一覧" class="permalink">&nbsp;&para;</a></h3><div id="バケツ-バケツ一覧-get" class="action get"><h4 class="action-heading"><div class="name">バケツ一覧の取得</div><a href="#バケツ-バケツ一覧-get" class="method get">GET</a><code class="uri">/v1/buckets</code></h4><p>存在するバケツのID一覧を返す。</p>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets</span></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[
  {
    "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"chunk"</span></span>,
    "<span class="hljs-attribute">device</span>": <span class="hljs-value"><span class="hljs-string">"device00"</span></span>,
    "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span>
  </span>}
]</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
  "<span class="hljs-attribute">items</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
    "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
        "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
      </span>}</span>,
      "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
        "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
      </span>}</span>,
      "<span class="hljs-attribute">type</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
        "<span class="hljs-attribute">enum</span>": <span class="hljs-value">[
          <span class="hljs-string">"dispersed"</span>,
          <span class="hljs-string">"replicated"</span>,
          <span class="hljs-string">"metadata"</span>,
          <span class="hljs-string">"dispersed"</span>
        ]</span>,
        "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内のデータの冗長化方式"</span>
      </span>}
    </span>}</span>,
    "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
      <span class="hljs-string">"id"</span>,
      <span class="hljs-string">"device"</span>,
      <span class="hljs-string">"type"</span>
    ]
  </span>}
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="バケツ-バケツ操作" class="resource"><h3 class="resource-heading">バケツ操作 <a href="#バケツ-バケツ操作" class="permalink">&nbsp;&para;</a></h3><div id="バケツ-バケツ操作-get" class="action get"><h4 class="action-heading"><div class="name">バケツ構成の取得</div><a href="#バケツ-バケツ操作-get" class="method get">GET</a><code class="uri">/v1/buckets/{bucket_id}</code></h4><p>指定されたバケツの構成を取得する。</p>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">foo</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>foo</span></span><p>操作対象のバケツのID</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">dispersed</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">data_fragment_count</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
    "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"chunk"</span></span>,
    "<span class="hljs-attribute">device</span>": <span class="hljs-value"><span class="hljs-string">"device00"</span></span>,
    "<span class="hljs-attribute">seqno</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
    "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value"><span class="hljs-number">1000</span></span>,
    "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value"><span class="hljs-number">3</span>
  </span>}
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{}</span>,
  "<span class="hljs-attribute">oneOf</span>": <span class="hljs-value">[
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">dispersed</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">data_fragment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"ErasureCodingにおけるデータフラグメントの数(正の整数)"</span>
            </span>}</span>,
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"data_fragment_count"</span>,
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>},
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">replicated</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>},
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">metadata</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>}
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>指定されたバケツが存在しない。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div><div id="バケツ-バケツ操作-put" class="action put"><h4 class="action-heading"><div class="name">バケツの作成・更新</div><a href="#バケツ-バケツ操作-put" class="method put">PUT</a><code class="uri">/v1/buckets/{bucket_id}</code></h4><p>バケツの新規作成、あるいは更新を行う。</p>
<h4>Example URI</h4><div class="definition"><span class="method put">PUT</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">foo</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>foo</span></span><p>操作対象のバケツのID</p>
</dd></dl></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">dispersed</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">data_fragment_count</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
    "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"chunk"</span></span>,
    "<span class="hljs-attribute">device</span>": <span class="hljs-value"><span class="hljs-string">"device00"</span></span>,
    "<span class="hljs-attribute">seqno</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
    "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value"><span class="hljs-number">1000</span></span>,
    "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value"><span class="hljs-number">3</span>
  </span>}
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{}</span>,
  "<span class="hljs-attribute">oneOf</span>": <span class="hljs-value">[
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">dispersed</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">data_fragment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"ErasureCodingにおけるデータフラグメントの数(正の整数)"</span>
            </span>}</span>,
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"data_fragment_count"</span>,
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>},
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">replicated</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>},
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">metadata</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>}
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>バケツが更新された。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">dispersed</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">data_fragment_count</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
    "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"chunk"</span></span>,
    "<span class="hljs-attribute">device</span>": <span class="hljs-value"><span class="hljs-string">"device00"</span></span>,
    "<span class="hljs-attribute">seqno</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
    "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value"><span class="hljs-number">1000</span></span>,
    "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value"><span class="hljs-number">3</span>
  </span>}
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{}</span>,
  "<span class="hljs-attribute">oneOf</span>": <span class="hljs-value">[
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">dispersed</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">data_fragment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"ErasureCodingにおけるデータフラグメントの数(正の整数)"</span>
            </span>}</span>,
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"data_fragment_count"</span>,
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>},
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">replicated</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>},
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">metadata</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>}
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>201</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>バケツが作成された。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">dispersed</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">data_fragment_count</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
    "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"chunk"</span></span>,
    "<span class="hljs-attribute">device</span>": <span class="hljs-value"><span class="hljs-string">"device00"</span></span>,
    "<span class="hljs-attribute">seqno</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
    "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value"><span class="hljs-number">1000</span></span>,
    "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value"><span class="hljs-number">3</span>
  </span>}
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{}</span>,
  "<span class="hljs-attribute">oneOf</span>": <span class="hljs-value">[
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">dispersed</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">data_fragment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"ErasureCodingにおけるデータフラグメントの数(正の整数)"</span>
            </span>}</span>,
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"data_fragment_count"</span>,
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>},
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">replicated</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>},
    {
      "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">metadata</span>": <span class="hljs-value">{
          "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
          "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
            "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
            </span>}</span>,
            "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
            </span>}</span>,
            "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
              "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
            </span>}</span>,
            "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
              "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
              "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
            </span>}
          </span>}</span>,
          "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
            <span class="hljs-string">"id"</span>,
            <span class="hljs-string">"device"</span>,
            <span class="hljs-string">"seqno"</span>,
            <span class="hljs-string">"tolerable_faults"</span>
          ]
        </span>}
      </span>}
    </span>}
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>400</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>指定されたバケツの構成が不正だったり、対象のバケツが更新をサポートしていない場合に返される。
なお、更新をサポートしているのは、種別が<code>metadata</code>のバケツのみである。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div><div id="バケツ-バケツ操作-delete" class="action delete"><h4 class="action-heading"><div class="name">バケツの削除（未実装）</div><a href="#バケツ-バケツ操作-delete" class="method delete">DELETE</a><code class="uri">/v1/buckets/{bucket_id}</code></h4><p>指定されたバケツを削除する。</p>
<h4>Example URI</h4><div class="definition"><span class="method delete">DELETE</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">foo</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>foo</span></span><p>操作対象のバケツのID</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>削除されたバケツの構成を返す。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"chunk"</span></span>,
  "<span class="hljs-attribute">device</span>": <span class="hljs-value"><span class="hljs-string">"device00"</span></span>,
  "<span class="hljs-attribute">seqno</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
  "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value"><span class="hljs-number">1000</span></span>,
  "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value"><span class="hljs-number">3</span>
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツのID"</span>
    </span>}</span>,
    "<span class="hljs-attribute">device</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツの中身(オブジェクト群)を保存するのに使用するデバイスのID"</span>
    </span>}</span>,
    "<span class="hljs-attribute">seqno</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"バケツ内部で自動採番されている数値。利用者が意識する必要はない。"</span>
    </span>}</span>,
    "<span class="hljs-attribute">segment_count</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメント数 (正の整数)"</span></span>,
      "<span class="hljs-attribute">default</span>": <span class="hljs-value"><span class="hljs-number">1000</span>
    </span>}</span>,
    "<span class="hljs-attribute">tolerable_faults</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"故障耐性数 (非負の整数)"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"id"</span>,
    <span class="hljs-string">"device"</span>,
    <span class="hljs-string">"seqno"</span>,
    <span class="hljs-string">"tolerable_faults"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section><section id="オブジェクト" class="resource-group"><h2 class="group-heading">オブジェクト <a href="#オブジェクト" class="permalink">&para;</a></h2><div id="オブジェクト-オブジェクト操作" class="resource"><h3 class="resource-heading">オブジェクト操作 <a href="#オブジェクト-オブジェクト操作" class="permalink">&nbsp;&para;</a></h3><p>個々のオブジェクトに対する操作。HTTP ヘッダーで <code>If-None</code>, <code>If-None-Match</code> のいずれも指定しなかった場合はオブジェクトのバージョン確認は<strong>されない</strong>。</p>
<p>指定可能な HTTP Header は以下のとおり。</p>
<ul>
<li>
<p><code>If-None</code></p>
<ul>
<li>オブジェクトのバージョンがこのヘッダーで指定した値の場合のみ操作が適用される。</li>
<li><code>*</code> を指定すると任意のバージョンに対して操作が適用される。</li>
</ul>
</li>
<li>
<p><code>If-None-Match</code></p>
<ul>
<li>オブジェクトのバージョンがこのヘッダーで指定した値以外の場合のみ操作が適用される。</li>
<li><code>*</code> を指定するとオブジェクトが存在しない場合のみ操作が適用される。</li>
</ul>
</li>
</ul>
<div id="オブジェクト-オブジェクト操作-get" class="action get"><h4 class="action-heading"><div class="name">オブジェクトの取得</div><a href="#オブジェクト-オブジェクト操作-get" class="method get">GET</a><code class="uri">/v1/buckets/{bucket_id}/objects/{object_id}{?deadline,consistency,subset}</code></h4><p><code>object_id</code>で指定されたオブジェクトの内容を取得する。</p>
<h3 id="header-注記">注記 <a class="permalink" href="#header-注記" aria-hidden="true">¶</a></h3>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">foo</span>/objects/<span class="hljs-attribute" title="object_id">bar</span>?<span class="hljs-attribute">deadline=</span><span class="hljs-literal">5000</span>&<span class="hljs-attribute">consistency=</span><span class="hljs-literal">consistent</span>&<span class="hljs-attribute">subset=</span><span class="hljs-literal">2</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>foo</span></span><p>操作対象のバケツのID</p>
</dd><dt>object_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>bar</span></span><p>操作対象のオブジェクトのID</p>
</dd><dt>deadline</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>5000</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>5000</span></span><p>処理完了までのデッドライン(ミリ秒)</p>
</dd><dt>consistency</dt><dd><code>string</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>consistent</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>consistent</span></span><p>オブジェクト取得時の整合性の指定。consistent, quorum, stale, subset のいずれかを指定する。</p>
</dd><dt>subset</dt><dd><code>number</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>2</span></span><p>整合性の指定に subset を指定した時にいくつの MDS ノードからオブジェクト取得を試みるかを指定する。</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>以前にPUTされたオブジェクトの内容を取得する。</p>
<p>応答ヘッダの<code>ETag</code>には、該当オブジェクトのバージョンが格納される。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/octet-stream</span><br><span class="hljs-attribute">ETag</span>: <span class="hljs-string">10</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>${オブジェクトの内容}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>対象オブジェクトが存在しない。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>410</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p><code>object_id</code>に対応するオブジェクトは存在するが、内容が壊れている。</p>
<p>再び利用可能にするには、ユーザが再度PUTを発行する必要がある可能性が高い。</p>
<p>応答ヘッダの<code>ETag</code>には、該当オブジェクトのバージョンが格納される。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span><br><span class="hljs-attribute">ETag</span>: <span class="hljs-string">10</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div><div id="オブジェクト-オブジェクト操作-head" class="action head"><h4 class="action-heading"><div class="name">オブジェクトの存在確認</div><a href="#オブジェクト-オブジェクト操作-head" class="method head">HEAD</a><code class="uri">/v1/buckets/{bucket_id}/objects/{object_id}{?deadline,consistency,subset}</code></h4><p><code>object_id</code>で指定されたオブジェクトが存在するかを確認する。</p>
<h3 id="header-注記-1">注記 <a class="permalink" href="#header-注記-1" aria-hidden="true">¶</a></h3>
<h4>Example URI</h4><div class="definition"><span class="method head">HEAD</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">foo</span>/objects/<span class="hljs-attribute" title="object_id">bar</span>?<span class="hljs-attribute">deadline=</span><span class="hljs-literal">5000</span>&<span class="hljs-attribute">consistency=</span><span class="hljs-literal">consistent</span>&<span class="hljs-attribute">subset=</span><span class="hljs-literal">2</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>foo</span></span><p>操作対象のバケツのID</p>
</dd><dt>object_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>bar</span></span><p>操作対象のオブジェクトのID</p>
</dd><dt>deadline</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>5000</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>5000</span></span><p>処理完了までのデッドライン(ミリ秒)</p>
</dd><dt>consistency</dt><dd><code>string</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>consistent</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>consistent</span></span><p>オブジェクト取得時の整合性の指定。consistent, quorum, stale, subset のいずれかを指定する。</p>
</dd><dt>subset</dt><dd><code>number</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>2</span></span><p>整合性の指定に subset を指定した時にいくつの MDS ノードからオブジェクト取得を試みるかを指定する。</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>応答ヘッダの<code>ETag</code>には、該当オブジェクトのバージョンが格納される。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/octet-stream</span><br><span class="hljs-attribute">ETag</span>: <span class="hljs-string">10</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>対象オブジェクトが存在しない。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div><div id="オブジェクト-オブジェクト操作-put" class="action put"><h4 class="action-heading"><div class="name">オブジェクトの作成・更新</div><a href="#オブジェクト-オブジェクト操作-put" class="method put">PUT</a><code class="uri">/v1/buckets/{bucket_id}/objects/{object_id}{?deadline}</code></h4><p>オブジェクトの新規作成、あるいは更新を行う。</p>
<h4>Example URI</h4><div class="definition"><span class="method put">PUT</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">foo</span>/objects/<span class="hljs-attribute" title="object_id">bar</span>?<span class="hljs-attribute">deadline=</span><span class="hljs-literal">5000</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>foo</span></span><p>操作対象のバケツのID</p>
</dd><dt>object_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>bar</span></span><p>操作対象のオブジェクトのID</p>
</dd><dt>deadline</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>5000</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>5000</span></span><p>処理完了までのデッドライン(ミリ秒)</p>
</dd></dl></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/octet-stream</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>${オブジェクトの内容}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>オブジェクトが更新された。</p>
<p>応答ヘッダの<code>ETag</code>には、更新後のオブジェクトのバージョンが格納される。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">ETag</span>: <span class="hljs-string">10</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>201</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>オブジェクトが作成された。</p>
<p>応答ヘッダの<code>ETag</code>には、作成後のオブジェクトのバージョンが格納される。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">ETag</span>: <span class="hljs-string">10</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>412</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p><code>expect</code>パラメータで指定された条件と、実際のオブジェクトのバージョンが異なる。</p>
<p>応答ヘッダの<code>ETag</code>には、現在のオブジェクトのバージョンが格納される。
なお、オブジェクトが存在しない場合には、このヘッダは応答には含まれない。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span><br><span class="hljs-attribute">ETag</span>: <span class="hljs-string">10</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div><div id="オブジェクト-オブジェクト操作-delete" class="action delete"><h4 class="action-heading"><div class="name">オブジェクトの削除</div><a href="#オブジェクト-オブジェクト操作-delete" class="method delete">DELETE</a><code class="uri">/v1/buckets/{bucket_id}/objects/{object_id}{?deadline}</code></h4><p>オブジェクトの削除を行う。</p>
<p>対象オブジェクトが存在しない場合には、<code>404</code>応答が返される。</p>
<h4>Example URI</h4><div class="definition"><span class="method delete">DELETE</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">foo</span>/objects/<span class="hljs-attribute" title="object_id">bar</span>?<span class="hljs-attribute">deadline=</span><span class="hljs-literal">5000</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>foo</span></span><p>操作対象のバケツのID</p>
</dd><dt>object_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>bar</span></span><p>操作対象のオブジェクトのID</p>
</dd><dt>deadline</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>5000</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>5000</span></span><p>処理完了までのデッドライン(ミリ秒)</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>オブジェクトが削除された。</p>
<p>応答ヘッダの<code>ETag</code>には、削除されたオブジェクトのバージョンが格納される。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">ETag</span>: <span class="hljs-string">10</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>対象オブジェクトが存在しない。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>412</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p><code>expect</code>パラメータで指定された条件と、実際のオブジェクトのバージョンが異なる。</p>
<p>応答ヘッダの<code>ETag</code>には、現在のオブジェクトのバージョンが格納される。
なお、オブジェクトが存在しない場合には、このヘッダは応答には含まれない。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span><br><span class="hljs-attribute">ETag</span>: <span class="hljs-string">10</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section><section id="オブジェクトプレフィックス" class="resource-group"><h2 class="group-heading">オブジェクトプレフィックス <a href="#オブジェクトプレフィックス" class="permalink">&para;</a></h2><div id="オブジェクトプレフィックス-プレフィックス指定でのオブジェクト操作" class="resource"><h3 class="resource-heading">プレフィックス指定でのオブジェクト操作 <a href="#オブジェクトプレフィックス-プレフィックス指定でのオブジェクト操作" class="permalink">&nbsp;&para;</a></h3><div id="オブジェクトプレフィックス-プレフィックス指定でのオブジェクト操作-delete" class="action delete"><h4 class="action-heading"><div class="name">オブジェクトの削除</div><a href="#オブジェクトプレフィックス-プレフィックス指定でのオブジェクト操作-delete" class="method delete">DELETE</a><code class="uri">/v1/buckets/{bucket_id}/object_prefixes/{object_prefix}</code></h4><p>指定したプレフィックスを ID のプレフィックスに持つオブジェクトを削除する。</p>
<p>例えば、<code>lv123</code>, <code>25lv25</code> の ID を持つオブジェクトが登録されている場合に、<code>lv</code> を <code>object_prefix</code> に指定すると、<code>lv123</code> のみ削除される。</p>
<p>削除されたオブジェクトが1つもなくても <code>200</code> 応答が返される。</p>
<h4>Example URI</h4><div class="definition"><span class="method delete">DELETE</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">live</span>/object_prefixes/<span class="hljs-attribute" title="object_prefix">lv3293</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>live</span></span><p>操作対象のバケツのID</p>
</dd><dt>object_prefix</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>lv3293</span></span><p>削除対象のオブジェクトのIDのプレフィックス</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>オブジェクトが削除された。</p>
</div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">total</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span>
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">total</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"削除されたオブジェクト総数の文字列表現(JSON で表現できない巨大な数になりうるため)"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section><section id="セグメント" class="resource-group"><h2 class="group-heading">セグメント <a href="#セグメント" class="permalink">&para;</a></h2><div id="セグメント-セグメント一覧" class="resource"><h3 class="resource-heading">セグメント一覧 <a href="#セグメント-セグメント一覧" class="permalink">&nbsp;&para;</a></h3><div id="セグメント-セグメント一覧-get" class="action get"><h4 class="action-heading"><div class="name">セグメント一覧の取得</div><a href="#セグメント-セグメント一覧-get" class="method get">GET</a><code class="uri">/v1/buckets/{bucket_id}/segments</code></h4><p>指定されたバケツのセグメント一覧を取得する。</p>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">foo</span>/segments</span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>foo</span></span><p>操作対象のバケツのID</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[
  {
    "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">0</span>
  </span>}
]</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
  "<span class="hljs-attribute">items</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
    "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
        "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"セグメントのID"</span>
      </span>}
    </span>}</span>,
    "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
      <span class="hljs-string">"id"</span>
    ]
  </span>}
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>対象のバケツが存在しない。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="セグメント-セグメント操作" class="resource"><h3 class="resource-heading">セグメント操作 <a href="#セグメント-セグメント操作" class="permalink">&nbsp;&para;</a></h3><div id="セグメント-セグメント操作-get" class="action get"><h4 class="action-heading"><div class="name">セグメント構成の取得(未実装)</div><a href="#セグメント-セグメント操作-get" class="method get">GET</a><code class="uri">/v1/buckets/{bucket_id}/segments/{segment_id}</code></h4><p>指定されたセグメントの構成情報を返す。</p>
<p>TODO: 各デバイスに関して、データ同期が完了(i.e., 即座に利用可能か)しているかどうかのフラグを返しても良いかも
(statistics的なもので「Raftログのcommit済み地点」を返せば十分？)</p>
<h3 id="header-注記-2">注記 <a class="permalink" href="#header-注記-2" aria-hidden="true">¶</a></h3>
<p>応答の値は暫定。</p>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">foo</span>/segments/<span class="hljs-attribute" title="segment_id">0</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>foo</span></span><p>操作対象のバケツのID</p>
</dd><dt>segment_id</dt><dd><code>number</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>0</span></span><p>操作対象のセグメントのID</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">devices</span>": <span class="hljs-value">[
    <span class="hljs-string">"device00"</span>,
    <span class="hljs-string">"device01"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="セグメント-オブジェクト一覧" class="resource"><h3 class="resource-heading">オブジェクト一覧 <a href="#セグメント-オブジェクト一覧" class="permalink">&nbsp;&para;</a></h3><div id="セグメント-オブジェクト一覧-get" class="action get"><h4 class="action-heading"><div class="name">オブジェクト一覧の取得</div><a href="#セグメント-オブジェクト一覧-get" class="method get">GET</a><code class="uri">/v1/buckets/{bucket_id}/segments/{segment_id}/objects</code></h4><p>指定されたセグメントに属するオブジェクトの一覧を返す。</p>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">http://example.com</span>/v1/buckets/<span class="hljs-attribute" title="bucket_id">foo</span>/segments/<span class="hljs-attribute" title="segment_id">0</span>/objects</span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>bucket_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>foo</span></span><p>操作対象のバケツのID</p>
</dd><dt>segment_id</dt><dd><code>number</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>0</span></span><p>操作対象のセグメントのID</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[
  {
    "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"sm9"</span></span>,
    "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-number">3</span>
  </span>}
]</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
  "<span class="hljs-attribute">items</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
    "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
        "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"オブジェクトのID"</span>
      </span>}</span>,
      "<span class="hljs-attribute">version</span>": <span class="hljs-value">{
        "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
        "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"オブジェクトのバージョン"</span>
      </span>}
    </span>}</span>,
    "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
      <span class="hljs-string">"id"</span>,
      <span class="hljs-string">"version"</span>
    ]
  </span>}
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>400</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>セグメントIDが不正。セグメントIDに適切な型を指定しているか確認する。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>対象のセグメントが存在しない。存在しないバケツIDが指定された場合に返される。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>500</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>バケツは存在するがセグメントIDが存在するセグメント範囲を超えている。現在は実装の都合で 500 を返すが、将来的には 400 を返すように修正される予定。</p>
</div><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/problem+json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
  "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"Other"</span></span>,
  "<span class="hljs-attribute">cause</span>": <span class="hljs-value"><span class="hljs-string">"Not Found"</span></span>,
  "<span class="hljs-attribute">history</span>": <span class="hljs-value">[
    <span class="hljs-literal">null</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
  "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
  "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
  "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
    "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーの種類を表す文字列"</span>
    </span>}</span>,
    "<span class="hljs-attribute">cause</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーを発生させた原因の説明"</span>
    </span>}</span>,
    "<span class="hljs-attribute">history</span>": <span class="hljs-value">{
      "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
      "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"エラーが発生するまでに経由したコード上の経路情報。デバッグ用の情報。"</span>
    </span>}
  </span>}</span>,
  "<span class="hljs-attribute">required</span>": <span class="hljs-value">[
    <span class="hljs-string">"kind"</span>,
    <span class="hljs-string">"cause"</span>,
    <span class="hljs-string">"history"</span>
  ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 21 Jan 2020</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */
'use strict';

/*
  Determine if a string ends with another string.
*/
function endsWith(str, suffix) {
    return str.indexOf(suffix, str.length - suffix.length) !== -1;
}

/*
  Get a list of direct child elements by class name.
*/
function childrenByClass(element, name) {
  var filtered = [];

  for (var i = 0; i < element.children.length; i++) {
    var child = element.children[i];
    var classNames = child.className.split(' ');
    if (classNames.indexOf(name) !== -1) {
      filtered.push(child);
    }
  }

  return filtered;
}

/*
  Get an array [width, height] of the window.
*/
function getWindowDimensions() {
  var w = window,
      d = document,
      e = d.documentElement,
      g = d.body,
      x = w.innerWidth || e.clientWidth || g.clientWidth,
      y = w.innerHeight || e.clientHeight || g.clientHeight;

  return [x, y];
}

/*
  Collapse or show a request/response example.
*/
function toggleCollapseButton(event) {
    var button = event.target.parentNode;
    var content = button.parentNode.nextSibling;
    var inner = content.children[0];

    if (button.className.indexOf('collapse-button') === -1) {
      // Clicked without hitting the right element?
      return;
    }

    if (content.style.maxHeight && content.style.maxHeight !== '0px') {
        // Currently showing, so let's hide it
        button.className = 'collapse-button';
        content.style.maxHeight = '0px';
    } else {
        // Currently hidden, so let's show it
        button.className = 'collapse-button show';
        content.style.maxHeight = inner.offsetHeight + 12 + 'px';
    }
}

function toggleTabButton(event) {
    var i, index;
    var button = event.target;

    // Get index of the current button.
    var buttons = childrenByClass(button.parentNode, 'tab-button');
    for (i = 0; i < buttons.length; i++) {
        if (buttons[i] === button) {
            index = i;
            button.className = 'tab-button active';
        } else {
            buttons[i].className = 'tab-button';
        }
    }

    // Hide other tabs and show this one.
    var tabs = childrenByClass(button.parentNode.parentNode, 'tab');
    for (i = 0; i < tabs.length; i++) {
        if (i === index) {
            tabs[i].style.display = 'block';
        } else {
            tabs[i].style.display = 'none';
        }
    }
}

/*
  Collapse or show a navigation menu. It will not be hidden unless it
  is currently selected or `force` has been passed.
*/
function toggleCollapseNav(event, force) {
    var heading = event.target.parentNode;
    var content = heading.nextSibling;
    var inner = content.children[0];

    if (heading.className.indexOf('heading') === -1) {
      // Clicked without hitting the right element?
      return;
    }

    if (content.style.maxHeight && content.style.maxHeight !== '0px') {
      // Currently showing, so let's hide it, but only if this nav item
      // is already selected. This prevents newly selected items from
      // collapsing in an annoying fashion.
      if (force || window.location.hash && endsWith(event.target.href, window.location.hash)) {
        content.style.maxHeight = '0px';
      }
    } else {
      // Currently hidden, so let's show it
      content.style.maxHeight = inner.offsetHeight + 12 + 'px';
    }
}

/*
  Refresh the page after a live update from the server. This only
  works in live preview mode (using the `--server` parameter).
*/
function refresh(body) {
    document.querySelector('body').className = 'preload';
    document.body.innerHTML = body;

    // Re-initialize the page
    init();
    autoCollapse();

    document.querySelector('body').className = '';
}

/*
  Determine which navigation items should be auto-collapsed to show as many
  as possible on the screen, based on the current window height. This also
  collapses them.
*/
function autoCollapse() {
  var windowHeight = getWindowDimensions()[1];
  var itemsHeight = 64; /* Account for some padding */
  var itemsArray = Array.prototype.slice.call(
    document.querySelectorAll('nav .resource-group .heading'));

  // Get the total height of the navigation items
  itemsArray.forEach(function (item) {
    itemsHeight += item.parentNode.offsetHeight;
  });

  // Should we auto-collapse any nav items? Try to find the smallest item
  // that can be collapsed to show all items on the screen. If not possible,
  // then collapse the largest item and do it again. First, sort the items
  // by height from smallest to largest.
  var sortedItems = itemsArray.sort(function (a, b) {
    return a.parentNode.offsetHeight - b.parentNode.offsetHeight;
  });

  while (sortedItems.length && itemsHeight > windowHeight) {
    for (var i = 0; i < sortedItems.length; i++) {
      // Will collapsing this item help?
      var itemHeight = sortedItems[i].nextSibling.offsetHeight;
      if ((itemsHeight - itemHeight <= windowHeight) || i === sortedItems.length - 1) {
        // It will, so let's collapse it, remove its content height from
        // our total and then remove it from our list of candidates
        // that can be collapsed.
        itemsHeight -= itemHeight;
        toggleCollapseNav({target: sortedItems[i].children[0]}, true);
        sortedItems.splice(i, 1);
        break;
      }
    }
  }
}

/*
  Initialize the interactive functionality of the page.
*/
function init() {
    var i, j;

    // Make collapse buttons clickable
    var buttons = document.querySelectorAll('.collapse-button');
    for (i = 0; i < buttons.length; i++) {
        buttons[i].onclick = toggleCollapseButton;

        // Show by default? Then toggle now.
        if (buttons[i].className.indexOf('show') !== -1) {
            toggleCollapseButton({target: buttons[i].children[0]});
        }
    }

    var responseCodes = document.querySelectorAll('.example-names');
    for (i = 0; i < responseCodes.length; i++) {
        var tabButtons = childrenByClass(responseCodes[i], 'tab-button');
        for (j = 0; j < tabButtons.length; j++) {
            tabButtons[j].onclick = toggleTabButton;

            // Show by default?
            if (j === 0) {
                toggleTabButton({target: tabButtons[j]});
            }
        }
    }

    // Make nav items clickable to collapse/expand their content.
    var navItems = document.querySelectorAll('nav .resource-group .heading');
    for (i = 0; i < navItems.length; i++) {
        navItems[i].onclick = toggleCollapseNav;

        // Show all by default
        toggleCollapseNav({target: navItems[i].children[0]});
    }
}

// Initial call to set up buttons
init();

window.onload = function () {
    autoCollapse();
    // Remove the `preload` class to enable animations
    document.querySelector('body').className = '';
};
</script></body></html>