This repository has been archived by the owner on Aug 16, 2018. It is now read-only.
/
selectel-api.html
1300 lines (1251 loc) · 92.7 KB
/
selectel-api.html
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
<section id="storage_guide">
<h1 class="title">Пользовательское ReST API</h1>
<div class="contents topic" id="id1">
<p class="topic-title first">Содержание</p>
<ul class="simple">
<li><a class="reference internal" href="#api" id="id27">Поддерживаемое API</a></li>
<li><a class="reference internal" href="#id2" id="id28">Аутентификация</a></li>
<li><a class="reference internal" href="#id3" id="id29">Операции с хранилищем</a><ul>
<li><a class="reference internal" href="#id4" id="id30">Информация по хранилищу</a></li>
<li><a class="reference internal" href="#id5" id="id31">Список контейнеров</a></li>
<li><a class="reference internal" href="#id6" id="id32">Создание контейнера</a></li>
<li><a class="reference internal" href="#id7" id="id33">Информация по контейнеру</a></li>
<li><a class="reference internal" href="#id8" id="id34">Изменение мета-данных контейнера</a></li>
<li><a class="reference internal" href="#id9" id="id35">Удаление контейнера</a></li>
<li><a class="reference internal" href="#id10" id="id36">Галерея изображений</a></li>
<li><a class="reference internal" href="#id11" id="id37">Список файлов в контейнере</a></li>
<li><a class="reference internal" href="#id12" id="id38">Скачивание файла</a></li>
<li><a class="reference internal" href="#id13" id="id39">Загрузка файла</a></li>
<li><a class="reference internal" href="#id14" id="id40">Распаковка архивов</a></li>
<li><a class="reference internal" href="#id15" id="id41">Установка мета-данных файла</a></li>
<li><a class="reference internal" href="#id16" id="id42">Копирование файлов в контейнерах</a></li>
<li><a class="reference internal" href="#id17" id="id43">Удаление файла</a></li>
<li><a class="reference internal" href="#id18" id="id44">Управление заголовками для файлов</a></li>
<li><a class="reference internal" href="#symlink" id="id45">Ссылки на файл или каталог (symlink)</a></li>
<li><a class="reference internal" href="#id19" id="id46">Генерация ссылок для скачивания файлов</a></li>
<li><a class="reference internal" href="#sendmefile" id="id47">Ссылки на загрузку файлов (sendmefile)</a></li>
<li><a class="reference internal" href="#id20" id="id48">Специальные страницы</a></li>
<li><a class="reference internal" href="#zip" id="id49">Скачивание всего содержимого в виде zip архива</a></li>
<li><a class="reference internal" href="#id21" id="id50">Лимиты на хранение</a></li>
<li><a class="reference internal" href="#id22" id="id51">Версионирование</a></li>
<li><a class="reference internal" href="#cdn" id="id52">Сброс кэша CDN</a></li>
<li><a class="reference internal" href="#id23" id="id53">Получение статуса очистки кэша CDN</a></li>
<li><a class="reference internal" href="#ssl" id="id54">Управление пользовательскими ssl-сертификатами</a></li>
<li><a class="reference internal" href="#id24" id="id55">Управление доменами контейнера</a></li>
<li><a class="reference internal" href="#id25" id="id56">Управление подпользователями</a></li>
<li><a class="reference internal" href="#id26" id="id57">Получение логов запросов к хранилищу</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="api">
<h1><a class="toc-backref" href="#id1">Поддерживаемое API</a></h1>
<p>Хранилище полностью поддерживает OpenStack Swift API и дополнительно Amazon S3 API.</p>
</div>
<div class="section" id="id2">
<h1><a class="toc-backref" href="#id1">Аутентификация</a></h1>
<p>Для выполнения аутентификации нужно отправить <strong>GET</strong> запрос на url <strong>https://auth.selcdn.ru/</strong> и передать следующие обязательные заголовки <strong>X-Auth-User</strong> и <strong>X-Auth-Key</strong>.</p>
<p>Где:</p>
<ul class="simple">
<li><em>X-Auth-User</em> - ваш номер договора (логин в общую панель управления <a class="reference external" href="http://support.selectel.ru/">http://support.selectel.ru/</a>)</li>
<li><em>X-Auth-Key</em> - пароль для данной услуги (он отличается от пароля для общей панели управления)</li>
</ul>
<p>Данную информацию вы можете получить на странице <em>Облачное хранилище</em> - <em>Пользователи</em>. Для генерации пароля услуги воспользуйтесь функцией <em>Настроить пароль</em></p>
<p>При успешной аутентификации будет получен HTTP ответ <strong>204 (No Content)</strong> с заголовками <strong>X-Storage-Url</strong> и <strong>X-Auth-Token</strong> содержащие данные необходимые для выполнения всех остальных операций с хранилищем:</p>
<ul class="simple">
<li><em>X-Storage-Url</em> - базовый адрес для выполнения операций с хранилищем</li>
<li><em>X-Auth-Token</em> - идентификатор авторизации (действителен 24 часа с момента первой аутентификации)</li>
<li><em>X-Expire-Auth-Token</em> - точное время действия идентификатора авторизации в секундах</li>
</ul>
<p>В случае ошибки аутентификации будет получен HTTP ответ <strong>403 (Forbidden)</strong>.</p>
<p>Пример:</p>
<pre class="literal-block">
$ curl -i https://auth.selcdn.ru/ \
-H "X-Auth-User:user" \
-H "X-Auth-Key:password"
# вывод curl сокращен в целях удобочитаемости
> HTTP/1.1 204 No Content
> X-Expire-Auth-Token: 86029
> X-Storage-Url: https://xxx.selcdn.ru/
> X-Auth-Token: 285a05336fe0317beac78e84adac5f11
</pre>
<p>Дополнительно поддерживается аутентификация по протоколу v2.0 (keystone api).
Поддерживается только необходимый минимум этого протокола, поэтому некоторые расширенные возможности keystone могут не работать.</p>
<p>Пример аутентификации по v2.0 keystone:</p>
<pre class="literal-block">
$ curl -i -X POST https://auth.selcdn.ru/tokens \
-H 'Content-type: application/json' \
-d '{"auth": {"passwordCredentials": {"username": "user", "password": "password"}}}'
</pre>
<p>В качестве Tenant ID и Access Key следует указывать имя пользователя или дополнительного пользователя в Хранилище,
в качестве Secret Key - пароль пользователя, Region - Common.</p>
</div>
<div class="section" id="id3">
<h1><a class="toc-backref" href="#id1">Операции с хранилищем</a></h1>
<p>Во всех запросах к хранилищу должен передаваться заголовок <strong>X-Auth-Token</strong>, полученный при аутентификации, иначе будет получен отказ доступа.
Исключение, скачивание файла из публичного контейнера.</p>
<div class="section" id="id4">
<h2><a class="toc-backref" href="#id1">Информация по хранилищу</a></h2>
<p><strong>HEAD</strong> запрос на адрес <em>X-Storage-Url</em>.</p>
<p>В заголовках ответа будет получена следующая информация:</p>
<ul>
<li><p class="first"><em>X-Account-Bytes-Used</em> - суммарный объём хранения данных в хранилище (в байтах)</p>
</li>
<li><p class="first"><em>X-Account-Container-Count</em> - количество контейнеров</p>
</li>
<li><p class="first"><em>X-Account-Object-Count</em> - суммарное количество хранимых объектов</p>
</li>
<li><p class="first"><em>X-Transfered-Bytes</em> - скачено байт из хранилища (за всё время)</p>
</li>
<li><p class="first"><em>X-Received-Bytes</em> - закачено байт в хранилище (за всё время)</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
$ curl -I https://xxx.selcdn.ru/ \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11"
> HTTP/1.1 204 No Content
> X-Account-Object-Count: 5563
> X-Account-Bytes-Used: 6427888648
> X-Account-Container-Count: 27
> X-Received-Bytes: 110278989542
> X-Transfered-Bytes: 224961419192
</pre>
</blockquote>
</li>
</ul>
</div>
<div class="section" id="id5">
<h2><a class="toc-backref" href="#id1">Список контейнеров</a></h2>
<p><strong>GET</strong> запрос на адрес <em>X-Storage-Url</em>.</p>
<p>Дополнительные необязательные параметры запроса:</p>
<ul class="simple">
<li><em>limit</em> - число, ограничивает количество объектов в результате (по умолчанию 10000)</li>
<li><em>marker</em> - строка, результат будет содержать объекты по значению больше указанного маркера (полезно использовать для постраничной навигации и при большом количестве контейнеров)</li>
<li><em>format</em> - json или xml, результат будет выдан в указанном формате</li>
</ul>
<p>За один запрос можно получить информацию максимум о 10000 контейнерах, если контейнеров больше, нужно использовать дополнительные запросы с параметром marker.</p>
<blockquote>
<p>Примеры:</p>
<pre class="literal-block">
# получить листинг контейнеров с явным указание формата
$ curl -i https://xxx.selcdn.ru/\?format\=json \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11"
> HTTP/1.1 200 OK
> x-account-object-count: 5563
> x-account-bytes-used: 6427888648
> x-account-container-count: 27
> Content-Type: application/json; charset=utf-8
> Content-Length: 3033
> X-Received-Bytes: 110278989542
> X-Transfered-Bytes: 224978196408
>
> /* информация по контейнерам */
> [
> {
> /* место занимаемое содержимым контейнера */
> "bytes": 81292837,
> /* число объектов в контейнере */
> "count": 17,
> /* имя контейнера */
> "name": "container 1",
> /* всего закачанных в контейнер байт */
> "rx_bytes": 17936289,
> /* всего скачанных из контейнера байт */
> "tx_bytes": 11088956,
> /* тип контейнера */
> "type": "private"
> },
> {
> "bytes": 124355568,
> "count": 86,
> "name": "container 2",
> "rx_bytes": 296955064,
> "tx_bytes": 79205328,
> "type": "public"
> },
> ...
> ]
</pre>
</blockquote>
</div>
<div class="section" id="id6">
<h2><a class="toc-backref" href="#id1">Создание контейнера</a></h2>
<p><strong>PUT</strong> запрос на адрес <em>X-Storage-Url/container_name</em>.</p>
<p>Имя контейнера должно быть меньше 256 символов и не содержать завершающего слеша '/' в конце.</p>
<p><strong>HTTP ответы:</strong></p>
<ul class="simple">
<li><em>201 (Created)</em> - при успешном создании</li>
<li><em>202 (Accepted)</em> - если контейнер уже существует</li>
</ul>
<p>К контейнеру можно привязать произвольные мета-данные через передачу заголовков с префиксом <em>X-Container-Meta-</em>.</p>
<p>Так же можно указать специальные заголовки, которые меняют функциональные свойства контейнера:</p>
<ul>
<li><p class="first"><em>X-Container-Meta-Type</em> - тип контейнера (public, private, gallery)</p>
</li>
<li><p class="first"><a class="reference internal" href="#cors">дополнительные заголовки кэшировани и CORS</a></p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
$ curl -i -XPUT https://xxx.selcdn.ru/new_container \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Container-Meta-Type: public" \
-H "X-Container-Meta-Some: some_specific_meta_data"
> HTTP/1.1 201 Created
</pre>
</blockquote>
</li>
</ul>
</div>
<div class="section" id="id7">
<h2><a class="toc-backref" href="#id1">Информация по контейнеру</a></h2>
<p><strong>HEAD</strong> запрос на адрес <em>X-Storage-Url/container_name</em>.</p>
<p>В заголовках ответа будет получена следующая информация:</p>
<ul>
<li><p class="first"><em>X-Container-Object-Count</em> - количество объектов в контейнере</p>
</li>
<li><p class="first"><em>X-Container-Bytes-Used</em> - суммарный размер объектов в контейнере</p>
</li>
<li><p class="first"><em>X-Transfered-Bytes</em> - скачено байт из контейнера</p>
</li>
<li><p class="first"><em>X-Received-Bytes</em> - передано байт в контейнер</p>
</li>
<li><p class="first"><em>X-Container-Meta-Type</em> - тип контейнера (public или private)</p>
</li>
<li><p class="first"><em>X-Container-Meta-Domains</em> - привязанные домены к контейнеру</p>
</li>
<li><p class="first"><em>X-Container-Meta-*</em> - заголовки с произвольной пользовательской информацией</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
$ curl -I https://xxx.selcdn.ru/new_container \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11"
> HTTP/1.1 204 No Content
> x-container-object-count: 0
> x-container-bytes-used: 0
> x-container-meta-type: public
> x-container-meta-some: some_specific_meta_data
> X-Container-Domains:
> X-Transfered-Bytes: 0
> X-Received-Bytes: 0
</pre>
</blockquote>
</li>
</ul>
</div>
<div class="section" id="id8">
<h2><a class="toc-backref" href="#id1">Изменение мета-данных контейнера</a></h2>
<p><strong>POST</strong> запрос на адрес <em>X-Storage-Url/container_name</em> и указать заголовки с префиксом <strong>X-Container-Meta-</strong> которые нужно установить или поменять.</p>
<p><strong>HTTP ответы:</strong></p>
<ul>
<li><p class="first"><em>204 (No Content)</em> - изменение выполнено</p>
</li>
<li><p class="first"><em>404 (Not Found)</em> - указанный контейнер не существует</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
# смена типа контейнера на личный и установка других метаданных
$ curl -i -XPOST https://xxx.selcdn.ru/new_container \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Container-Meta-Type: private" \
-H "X-Container-Meta-Some: any text"
> HTTP/1.1 204 No Content
</pre>
</blockquote>
</li>
</ul>
</div>
<div class="section" id="id9">
<h2><a class="toc-backref" href="#id1">Удаление контейнера</a></h2>
<p><strong>DELETE</strong> запрос на адрес <em>X-Storage-Url/container_name</em>.</p>
<p>Удаляемый контейнер должен быть пуст, иначе операция не будет выполнена.</p>
<p><strong>HTTP ответы:</strong></p>
<ul>
<li><p class="first"><em>204 (No Content)</em> - при успешном удалении</p>
</li>
<li><p class="first"><em>404 (Not Found)</em> - указанный контейнер не существует</p>
</li>
<li><p class="first"><em>409 (Conflict)</em> - ошибка удаления, контейнер не пустой</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
$ curl -i -XDELETE https://xxx.selcdn.ru/new_container \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11"
> HTTP/1.1 204 No Content
</pre>
</blockquote>
</li>
</ul>
</div>
<div class="section" id="id10">
<h2><a class="toc-backref" href="#id1">Галерея изображений</a></h2>
<p>Контейнер можно преобразовать в галерею для удобного публичного представления в веб-браузере загруженных в нем фотографий и других изображений.</p>
<p>Создание галереи происходит путем установки типа контейнера <strong>gallery</strong>:</p>
<pre class="literal-block">
$ curl -i -XPUT https://xxx.selcdn.ru/gallery \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Container-Meta-Type: gallery"
</pre>
<p>По умолчанию, галерея является публичной и доступ (только просмотр) к ней может получить любой. Но, дополнительно, можно установить пароль, по которому будет ограничен доступ. Для этого в запросе нужно передать заголовок <strong>X-Container-Meta-Gallery-Secret</strong> со значением sha1-хеша пароля. Пример:</p>
<pre class="literal-block">
$ curl -i -XPUT https://xxx.selcdn.ru/gallery \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Container-Meta-Type: gallery"
-H "X-Container-Meta-Gallery-Secret: 91dfd9ddb4198affc5c194cd8ce6d338fde470e2" # sha1-хеш пароля mypassword
</pre>
</div>
<div class="section" id="id11">
<h2><a class="toc-backref" href="#id1">Список файлов в контейнере</a></h2>
<p><strong>GET</strong> запрос на адрес <em>X-Storage-Url/container_name</em>.</p>
<p>Дополнительные необязательные параметры запроса:</p>
<ul class="simple">
<li><em>limit</em> - число, ограничивает количество объектов в результате (по умолчанию 10000)</li>
<li><em>marker</em> - строка, результат будет содержать объекты по значению больше указанного маркера (полезно использовать для постраничной навигации и для большого количества файлов)</li>
<li><em>prefix</em> - строка, вернуть объекты имена которых начинаются с указанного префикса</li>
<li><em>path</em> - строка, вернуть объекты в указанной папке (виртуальные папки)</li>
<li><em>delimiter</em> - символ, вернуть объекты до указанного разделителя в их имени</li>
<li><em>format</em> - json или xml, результат будет выдан в указанном формате</li>
</ul>
<p>За один запрос можно получить информацию максимум о 10000 файлах в контейнере, если в контейнере содержится больше файлов то нужно использовать дополнительные запросы с параметром marker.</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
$ curl -i https://xxx.selcdn.ru/new_container/\?format\=json \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11"
> HTTP/1.1 200 OK
> x-container-meta-web-listings: on
> x-container-object-count: 4
> x-container-meta-access-control-request-method: HEAD, GET
> x-container-meta-web-listings-css: /my_style.css
> x-container-bytes-used: 1092
> x-container-meta-web-404-redirect: /trex_404.html
> x-container-meta-type: public
> x-container-meta-web-index: /my_index.html
> Content-Type: application/json; charset=utf-8
> Content-Length: 724
>
> /* информация о файлах */
> [
> {
> /* размер файла: */
> "bytes": 31,
> /* тип файла: */
> "content_type": "text/html",
> /* сколько раз данный файл был скачан: */
> "downloaded": 4,
> /* md5 хеш: */
> "hash": "b302ffc3b75770453e96c1348e30eb93",
> /* время загрузки файла: */
> "last_modified": "2013-05-27T14:42:04.669760",
> /* имя файла: */
> "name": "my_index.html"
> },
> {
> "bytes": 1024,
> "content_type": "application/octet-stream",
> "downloaded": 0,
> "hash": "0f343b0931126a20f133d67c2b018a3b",
> "last_modified": "2013-05-27T13:16:49.007590",
> "name": "new_object"
> },
> ...
> ]
</pre>
</blockquote>
</div>
<div class="section" id="id12">
<h2><a class="toc-backref" href="#id1">Скачивание файла</a></h2>
<p><strong>GET</strong> запрос на адрес <em>X-Storage-Url/container_name/path_to_file</em>.</p>
<p>Указание заголовка <em>X-Auth-Token</em> необходимо только если файл находиться внутри личного (приватного) контейнера.</p>
<p>Путь к файлу может содержать символ '/' как виртуальную папку.</p>
<p>Хранилище поддерживает условные запросы в соответствии с RFC 2616, вы можете указывать следующие заголовки:</p>
<ul>
<li><p class="first">If-Match</p>
</li>
<li><p class="first">If-None-Match</p>
</li>
<li><p class="first">If-Modified-Since</p>
</li>
<li><p class="first">If-Unmodified-Since</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
$ curl -O https://xxx.selcdn.ru/new_container/new_object \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11"
</pre>
</blockquote>
</li>
</ul>
</div>
<div class="section" id="id13">
<h2><a class="toc-backref" href="#id1">Загрузка файла</a></h2>
<p><strong>PUT</strong> запрос <em>X-Storage-Url/container_name/path_to_file</em>.</p>
<p>Файл может быть загружен только в контейнер, который должен существовать к моменту загрузки файла. Полное имя файла (включая виртуальные папки) не должно превышать 1024 байт после URL квотирования. Размер одного загружаемого файла не должен превышать 5 ГБ.</p>
<p>Загрузка может быть осуществлена целиком либо http-чанками. При загрузке целиком в заголовках должен быть указан размер файла в заголовке <strong>Content-Lenght</strong>.
При загрузке чанками должен быть указан соответствующий заголовок <strong>Transfer-Encoding: chunked</strong>.</p>
<p>К файлу может быть прикреплены произвольные мета-данные через указание заголовков с префиксом <strong>X-Object-Meta-</strong>. Суммарный размер заголовков не должен превышать 4 КБ.</p>
<p>При загрузке файла можно указать специальный заголовок <strong>ETag</strong> содержащий контрольную сумму MD5. После загрузки файла будет проведена проверка сохранённых данных по контрольным суммам, это позволяет убедиться что данные сохранены верно.</p>
<p>Так же можно указать заголовок <strong>Content-Type</strong> для задания типа файла. Заголовок <strong>Content-Disposition</strong> влияет на то как браузер будет обрабатывать получение файла из Хранилища.</p>
<p>Хранилище поддерживает автоматически удаляемые файлы. Для создание таких файлов нужно передать один из следующих заголовков:</p>
<ul class="simple">
<li><em>X-Delete-At</em> - время когда нужно удалить файл, указывается целое число в unix timestamp</li>
<li><em>X-Delete-After</em> - через какое время удалить файл, указывается в секундах</li>
</ul>
<p>При успешной загрузке файла будет получен HTTP ответ <strong>201 (Created)</strong> с заголовками <strong>Content-Lenght</strong>, <strong>Content-Type</strong> и <strong>Etag</strong>. В случае если при загрузке был указан заголовок <em>ETag</em> и проверка загруженных данных будет неудачна, то в ответ будет получен HTTP статус <strong>422 (Unprocessable Entity)</strong>.</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
$ curl -i -XPUT https://xxx.selcdn.ru/new_container/new_object \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Delete-After: 25200" \
-T "./example.gz"
> HTTP/1.1 100 Continue
> HTTP/1.1 201 Created
> etag: 0f343b0931126a20f133d67c2b018a3b
> Last-Modified: Mon, 27 May 2013 12:24:37 GMT
</pre>
</blockquote>
</div>
<div class="section" id="id14">
<h2><a class="toc-backref" href="#id1">Распаковка архивов</a></h2>
<p>Хранилище поддерживает возможность автоматической распаковки загружаемого архива. Поддерживаются следующие форматы архивов: tar, tar.gz, tar.bz2.</p>
<p>Для распаковки нужно при загрузке архива указать параметр запроса <strong>extract-archive=format</strong>, где за место <strong>format</strong> указать формат архива.</p>
<p>Пример загрузки архива с его распаковкой в хранилище:</p>
<pre class="literal-block">
# файлы будут распакованы в контейнер new_container
$ curl -i -X PUT 'https://xxx.selcdn.ru/new_container/?extract-archive=tar.bz2' \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-T "photos.tar.bz2"
</pre>
<p>В качестве пути для распаковки можно указывать контейнер, папку в контейнере или корень аккаунта. В последнем случае для папок первого уровня из архива будут созданы соответствующие контейнеры в хранилище.</p>
<p>После выполнения операции будет отдан ответ 200 с отчетом о результате распаковки. Поддерживается получение отчета в структурированном формате, для этого нужно при запросе указать заголовок <strong>Accept</strong> с одним из значений: text/plain, application/json, application/xml или text/xml.</p>
<p>Пример отчета в json формате:</p>
<pre class="literal-block">
{"Response Status": "201 Created",
"Response Body": "", "Errors": [], "Number Files Created": 1237}
</pre>
<p>Из отчета можно получить информацию о количестве распакованных файлов и список возникших ошибок при распаковки.</p>
</div>
<div class="section" id="id15">
<h2><a class="toc-backref" href="#id1">Установка мета-данных файла</a></h2>
<p><strong>POST</strong> запрос на адрес <em>X-Storage-Url/container_name/path_to_file</em> и указать заголовки с префиксом <strong>X-Object-Meta-</strong> которые нужно установить или поменять.</p>
<p><strong>Внимание:</strong> установка мета-данных стирает все установленные ранее мета-данные для указанного файла и заменяет их на указанные в запросе.</p>
<p><strong>HTTP ответы:</strong></p>
<ul>
<li><p class="first"><em>204 (No Content)</em> - изменение выполнено</p>
</li>
<li><p class="first"><em>404 (Not Found)</em> - указанный контейнер не существует</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
$ curl -i -XPOST https://xxx.selcdn.ru/new_container/new_object \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Object-Meta-Another: another"
> HTTP/1.1 202 Accepted
</pre>
</blockquote>
</li>
</ul>
</div>
<div class="section" id="id16">
<h2><a class="toc-backref" href="#id1">Копирование файлов в контейнерах</a></h2>
<p>Можно копировать и перемещать файлы в пределах хранилища без повторной их загрузки. Операцию можно осуществить с помощью <strong>PUT</strong> или <strong>COPY</strong> запроса.</p>
<p><strong>PUT</strong> запрос на <em>X-Storage-Url/container_name/new_path_to_file</em> с обязательным заголовком <strong>X-Copy-From</strong> содержащим путь к исходному файлу относительно корня хранилища (например, <em>/container2/file3</em>) и заголовком <strong>Content-Lenght</strong> равным нулю (<strong>0</strong>).</p>
<p><strong>COPY</strong> запрос на <em>X-Storage-Url/container_name/orig_path_to_file</em> и заголовком <strong>Destination</strong> содержащим путь куда нужно копировать файл.</p>
<p>Для обоих запросов контейнер в который производиться копирование должен существовать.</p>
<p>При копировании также копируется и мета-данные о файле. Если в запросе указать заголовки с префиксом <strong>X-Object-Meta-</strong>, то для скопированного объекта будет установлены или перезаписаны (если они были в исходном файле) указанные мета-данные.</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
# первый способ
$ curl -i -XPUT https://xxx.selcdn.ru/new_container/first_copy \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "Content-Length: 0" \
-H "X-Copy-From: /new_container/new_object"
> HTTP/1.1 201 Created
> etag: 0f343b0931126a20f133d67c2b018a3b
> X-Copied-From: new_container/new_object
> X-Copied-From-Last-Modified: Mon, 27 May 2013 13:16:49 GMT
> Last-Modified: Tue, 28 May 2013 06:27:11 GMT
# второй способ
$ curl -i -XCOPY https://xxx.selcdn.ru/new_container/new_object \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "Destination: /new_container/second_copy"
> HTTP/1.1 201 Created
> etag: 0f343b0931126a20f133d67c2b018a3b
> X-Copied-From: new_container/new_object
> X-Copied-From-Last-Modified: Mon, 27 May 2013 13:16:49 GMT
> Last-Modified: Tue, 28 May 2013 06:30:51 GMT
</pre>
</blockquote>
</div>
<div class="section" id="id17">
<h2><a class="toc-backref" href="#id1">Удаление файла</a></h2>
<p><strong>DELETE</strong> запрос на адрес <em>X-Storage-Url/container_name/path_to_file</em>.</p>
<p><strong>HTTP ответы:</strong></p>
<ul class="simple">
<li><em>204 (No Content)</em> - при успешном удалении</li>
<li><em>404 (Not Found)</em> - если файла не существует</li>
</ul>
<blockquote id="cors">
<p>Пример:</p>
<pre class="literal-block">
$ curl -i -XDELETE https://xxx.selcdn.ru/new_container/new_object \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11"
> HTTP/1.1 204 No Content
</pre>
</blockquote>
</div>
<div class="section" id="id18">
<h2><a class="toc-backref" href="#id1">Управление заголовками для файлов</a></h2>
<p>Хранилище позволяет указывать специальные заголовки которые влияют на процесс получения файла из Хранилища.
В частности, позволяют управлять кэшированием данных на стороне клиента и промежуточных прокси серверах, а
так же задавать заголовки для обработки кросс-доменных запросов (CORS).</p>
<p>Поддерживаемые заголовки:</p>
<ul class="simple">
<li>Cache-Control</li>
<li>Expires</li>
<li>Origin</li>
<li>Access-Control-Allow-Origin</li>
<li>Access-Control-Max-Age</li>
<li>Access-Control-Allow-Methods</li>
<li>Access-Control-Allow-Credentials</li>
<li>Access-Control-Expose-Headers</li>
<li>Access-Control-Request-Headers</li>
<li>Access-Control-Request-Method</li>
<li>Content-Disposition (только для конечного файла)</li>
<li>Strict-Transport-Security (только на уровне контейнера)</li>
</ul>
<p>Вы можете установить значения по умолчанию для поддерживаемых заголовков на уровне контейнера.
Для этого для контейнера нужно установить соответствующие мета-данные <strong>X-Container-Meta-<header></strong>, где <em><header></em> заменить на нужный заголовок.
После задания этих значений для всех отдаваемых данных (методом GET) из контейнера будет устанавливаться соответствующие заголовки.</p>
<p>Так же вы можете установить или переопределить значения по умолчанию для конктерного файла в хранилище, заданием соответствующих мета-данных.</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
$ curl -i -XPOST https://xxx.selcdn.ru/new_container \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Container-Meta-Access-Control-Request-Method: HEAD, GET" \
-H "X-Container-Meta-Cache-Control: public" \
-H "X-Container-Meta-Strict-Transport-Security: max-age=31536000; includeSubDomains"
> HTTP/1.1 204 No Content
</pre>
</blockquote>
</div>
<div class="section" id="symlink">
<h2><a class="toc-backref" href="#id1">Ссылки на файл или каталог (symlink)</a></h2>
<p>Ссылки позволяют предоставлять доступ к файлам в хранилище используя альтернативное имя. В частности, это даёт возможность открывать публичный доступ к файлам из личного контейнера, а так же доступ между пользователями на одном аккаунте.</p>
<p>Вы можете создать специальный <em>объект-ссылку</em> которая будет будет указывать на другой объект в хранилище (только на файл) и настроить ряд дополнительных параметров (ограничить время действия, задать пароль).</p>
<p>Создание ссылки: <strong>PUT</strong> запрос на адрес <em>X-Storage-Url/container_name/link_name</em> с указанием ряда заголовков.</p>
<p><strong>Заголовки:</strong></p>
<ul>
<li><dl class="first docutils">
<dt><em>Content-Type</em> - определяет тип ссылки, возможные значения:</dt>
<dd><ul class="first last simple">
<li><em>x-storage/symlink</em> - обычная ссылка</li>
<li><em>x-storage/onetime-symlink</em> - одноразовая ссылка</li>
<li><em>x-storage/symlink+secure</em> - обычная запароленная ссылка</li>
<li><em>x-storage/onetime-symlink+secure</em> - одноразовая запароленная ссылка</li>
</ul>
</dd>
</dl>
</li>
<li><p class="first"><em>X-Object-Meta-Location</em> - цель ссылки, относительный заквотированный путь к объекту в хранилище (пример: <em>/container/path/to%20file</em>).</p>
</li>
<li><p class="first"><em>Content-Length: 0</em> - тело запроса обязательно должно быть пустым</p>
</li>
<li><p class="first"><em>X-Object-Meta-Delete-At</em> - время до которого ссылка будет действительна (unix timestamp), необязательно заголовок.</p>
</li>
<li><p class="first"><em>X-Object-Meta-Link-Key</em> - хеш ключа доступа к запароленной ссылке. Вычисление хеша: sha1(<cite>password</cite> + <cite>X-Object-Meta-Location</cite>).</p>
</li>
<li><p class="first"><em>Content-Disposition</em> - перекрывает соответствующий заголовок объекта, на который указывает ссылка.</p>
</li>
</ul>
<p>При обращение к объекту-ссылке (методом <strong>GET</strong>) в ответ будет получен объект на который она указывает. <strong>HEAD</strong>-запрос возвращает информацию о ссылке.</p>
<p>Для доступа к запароленной ссылке нужно в GET запросе указать параметр <strong>_sslk</strong> со значением пароля.</p>
<p>Объект-ссылка (но не цель ссылки) автоматически удаляется при истечение срока действия или при первом успешном скачивании для одноразовых ссылок.</p>
<blockquote>
<p>Пример:</p>
<pre class="literal-block">
$ curl -i -XPUT http://xxx.selcdn.ru/new_container/new_link \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "Content-Type: x-storage/symlink" \
-H "X-Object-Meta-Location: /new_container/new_object" \
-H "X-Object-Meta-Link-Key: b6589fc6ab0dc82cf12099d1c2d40ab994e8410c"\
-H "Content-Length: 0"
> HTTP/1.1 201 Created
> etag: d41d8cd98f00b204e9800998ecf8427e
> Last-Modified: Mon, 27 May 2013 13:34:34 GMT
</pre>
</blockquote>
<p>Символьные ссылки можно создавать и на каталоги. Для этого используются те же самые команды, что и при создании ссылки на файл, только в X-Object-Meta-Location указывается путь к каталогу. Такие ссылки должны располагаться в корне контейнера.</p>
</div>
<div class="section" id="id19">
<h2><a class="toc-backref" href="#id1">Генерация ссылок для скачивания файлов</a></h2>
<p>С помощью функции генерации ссылок можно создавать специальные ссылки для скачивания файлов, в том числе и из личных контейнеров. Срок действия ссылок ограничен.</p>
<p>В отличии от symlink, ссылки создаются без выполнения запросов к API. После создания ссылки невозможно отменить или удалить; они доступны в течении всего срока действия.</p>
<p>Прежде чем генерировать подобные ссылки, нужно установить секретный ключ. Ключ можно устанавливать как на уровне пользователя, так и на уровне контейнера. Секртеный ключ,
заданный для аккаунта, позволяет создавать ссылки на все файлы во всех контейнерах. Для установки такого глобального ключа следует выполнить авторизованный POST-запрос с заголовком X-Account-Meta-Temp-URL-Key.
Если требуется дать доступ на создание ссылок только в одном определенном контейнере, следует отправить на адрес контейнера POST-запрос с заголовком X-Container-Meta-Temp-URL-Key.
Здесь нужно иметь в виду, что запрос на установку пользовательского ключа следует выполнять от основного пользователя, подпользователи не имеют прав изменять глобальные настройки аккаунта.
Пример запроса установки секретного ключа аккаунта:</p>
<pre class="literal-block">
$ curl -i -XPOST http://xxx.selcdn.ru/ \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Account-Meta-Temp-URL-Key: secret_word"
> HTTP/1.1 204 No Content
</pre>
<p>Пример запроса установки секретного ключа контейнера:</p>
<pre class="literal-block">
$ curl -i -XPOST http://xxx.selcdn.ru/container1 \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Container-Meta-Temp-URL-Key: secret_word"
> HTTP/1.1 204 No Content
</pre>
<p>В этих примерах задается секретный ключ <em>secret_word</em>. Его нужно запомнить (в дальнейшем все ссылки будут генерироваться с его помощью) и защитить от постороннего доступа (доступ к файлам может получить любой пользователь, знающий секретный ключ).</p>
<p>Алгоритм генерации ссылки для языка python:</p>
<pre class="literal-block">
import hmac
from hashlib import sha1
from time import time
# данные для генерации ссылки
method = "GET" # метод доступа (всегда GET)
expires = int(time()) + 60 # ссылка действительная 60 секунд
path = "/container/dir/file" # путь к файлу в хранилище, всегда с указанием контейнера
link_secret_key = "secret_word" # секретный ключ
# генерация ключа доступа
hmac_body = '%s\n%s\n%s' % (method, expires, path)
sig = hmac.new(link_secret_key, hmac_body, sha1).hexdigest() # ключ доступа
</pre>
<p>Полученный в результате ключ нужно будет указать в ссылке. Ссылка может выглядеть, например, так:</p>
<pre class="literal-block">
http://xxx.selcdn.ru/container/dir/file?temp_url_sig=3f512dfed32111d6e742afc5522076c0621951cc&temp_url_expires=1390914227
</pre>
<p>где <strong>xxx.selcdn.ru</strong> базовый домен, значение <strong>temp_url_sig</strong> - ключ доступа, <strong>temp_url_expires</strong> - время до которого ссылка действительна (unixtime).</p>
<p>Вместо базового домена можно указывать привязанный в контейнеру домен. В таком случае указывать имя контейнера в ссылке не нужно, например:</p>
<pre class="literal-block">
http://my.domain/dir/file?temp_url_sig=3f512dfed32111d6e742afc5522076c0621951cc&temp_url_expires=1390914227
</pre>
<p>Дополнительно поддерживается управление заголовком <strong>Content-Disposition</strong> для отдаваемых по ссылке данных. Для этого нужно добавить параметр запроса <strong>filename</strong> с нужным значением. Пример:</p>
<pre class="literal-block">
http://xxx.selcdn.ru/container/dir/file?temp_url_sig=3f512dfed32111d6e742afc5522076c0621951cc&temp_url_expires=1390914227&filename=Other+file+name.doc
</pre>
<p>Секретный ключ при необходимости можно изменить, но в таком случае все сгенерированные ранее ссылки перестанут действовать.</p>
</div>
<div class="section" id="sendmefile">
<h2><a class="toc-backref" href="#id1">Ссылки на загрузку файлов (sendmefile)</a></h2>
<p>Ссылки на загрузку файлов - это специальная возможность позволяющая настроить загрузку файлов в Хранилище без авторизации. Она полезна когда вы хотите попросить кого-нибудь передать вам файлы, или для организации общего хранилища и даже для настройки резервного копирования. Ссылка на загрузку может быть использована для открытия в браузере и для работы с различными программами и утилитами, например, curl.</p>
<p>Сама ссылка создается как обычный файл в Хранилище для которого задаются специальные метаданные.</p>
<p>Поддерживается несколько типов ссылок, которые настраиваются указанием заголовка <strong>Content-Type</strong>:</p>
<blockquote>
<ul class="simple">
<li><strong>x-storage/sendmefile</strong> - обычная ссылка на загрузку файлов</li>
<li><strong>x-storage/sendmefile+inplace</strong> - загрузка только одного файла по указанному имени (имя ссылки является именем под которым будет сохранен загружаемый файл)</li>
<li><strong>x-storage/sendmefile+timepostfix</strong> - загрузка файлов с добавлением времени загрузки в имема файлов (с учетом расширения файлов)</li>
<li><strong>x-storage/sendmefile+autopostfix</strong> - загрузка файлов с добавлением уникального идентификатора в имема файлов (с учетом расширения файлов)</li>
<li><strong>x-storage/sendmefile+folderday</strong> - загрузка файлов в папку с именем состоящим из даты загрузки (год и день)</li>
<li><strong>x-storage/sendmefile+folderhour</strong> - загрузка файлов в папку с именем состоящим из даты и часа загрузки</li>
<li><strong>x-storage/sendmefile+folderuniq</strong> - загрузка файлов в папку с уникальным именем</li>
</ul>
</blockquote>
<p>Ссылки поддерживают ряд необязательных настроек:</p>
<blockquote>
<ul class="simple">
<li><strong>X-Object-Meta-Sendmefile-Disable-Web</strong> (yes|no) - отключение веб-интерфейса загрузки файлов (веб-интерфейс включен по умолчанию)</li>
<li><strong>X-Object-Meta-Sendmefile-Max-Size</strong> - максимальный размер загружаемого файла в байтах, не допускаются значения больше 5 Гб</li>
<li><strong>X-Object-Meta-Sendmefile-Allow-Overwrite</strong> (yes|no) - разрешить перезапись файла если он уже есть в Хранилище (по умолчанию перезапись запрещена)</li>
<li><strong>X-Object-Meta-Sendmefile-Default-Expire</strong> - время хранения загруженного файла по умолчанию, в секундах, может быть переопределено во время загрузки, не допускаются значения меньше часа</li>
<li><strong>X-Object-Meta-Sendmefile-Expire</strong> - время хранения загруженного файла, в секундах, не допускаются значения меньше часа</li>
<li><strong>X-Object-Meta-Sendmefile-Delete-At</strong> - точное время когда загруженные файлы будут удалены, формат unixtime</li>
<li><strong>X-Object-Meta-Sendmefile-Ignore-Filename</strong> (yes|no) - игнорировать изначальное имя загружаемого файла (полезно в сочетании с некоторыми типами ссылок)</li>
<li><strong>X-Object-Meta-Sendmefile-Secret</strong> - пароль на загрузку файлов, формат sha1-хеш пароля</li>
</ul>
</blockquote>
<p>Для веб-интерфейса загрузки предусмотрена возможность задания пояснительного текста. Установка пояснительного текста осуществляется отправкой тела запроса, длина текста ограничена 4096 символами.</p>
<p>Пример запроса создания ссылки на загрузку:</p>
<pre class="literal-block">
$ curl -i -XPUT https://xxx.selcdn.ru/container/upload \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "Content-Type: x-storage/sendmefile" \
-H "X-Object-Meta-Sendmefile-Max-Size: 52428800" \
-H "X-Object-Meta-Sendmefile-Expire: 14400" \
-H "X-Object-Meta-Sendmefile-Secret: 5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8" \
-d "Пояснительный текст для страницы загрузки"
</pre>
<p>Загрузка файла по ссылке осуществляется PUT-запросом на адрес ссылки. Дополнительно можно указывать следующие заголовки для запроса:</p>
<blockquote>
<ul class="simple">
<li><strong>X-Filename</strong> - название для файла под которым он будет загружен (Хранилище может изменить название в зависимости от типа ссылки на загрузку)</li>
<li><strong>X-Sendmefile-Session-Id</strong> - число, идентификатор сессии загрузки</li>
<li><strong>X-Sendmefile-TZ-Offset</strong> - коррекция времени, полезно для некоторых типов ссылок. Формат: число в минутах (пример, +240) или строка вида "hhmm[+|-]HHMM", где HH - смещение часов, MM - смещение минут (пример, hhmm-0400).</li>
</ul>
</blockquote>
<p>При успешной загрузке возвращается код ответа 201 Created и дополнительный заголовок <strong>X-Uploaded-As</strong> содержащий название файла под которым он был сохранен.</p>
<p>Если был установлен пароль на загрузку, то в запросе нужно передать параметр _ssuk=password, где password заданный пароль (не sha1-хеш).</p>
<p>Пример загрузки файла по ссылке:</p>
<pre class="literal-block">
# получение локального смещения времени (не обязательно)
$ d=`date +%z`
$ offset="hhmm"${d:0:1}$(( ${d:0:3} * 60 + ${d:3} ))
# загрузка файла
$ curl https://xxx.selcdn.ru/container/upload?_ssuk=password -i -X PUT \
-H "X-Filename: my_file.txt" \
-H "X-Sendmefile-TZ-Offset: ${offset}" \
-T path_to_file/my_file.txt
</pre>
<p>Передача пароля через параметр запроса <strong>_ssuk</strong> требует указание его в исходном виде. Чтобы этого избежать предусмотрен второй способ загрузки с безопасной подписью. Для этого нужно при загружке файла указать заголовок <strong>X-Sendmefile-Secret-Sig</strong> со специально сформированной значением в формате "expires.hmac_hash", где:</p>
<blockquote>
<ul class="simple">
<li><strong>expires</strong> - время, до которого подпись действительна (unix timestamp); рекомендуется указывать время действия на 5-15 минут</li>
<li><strong>hmac_hash</strong> - hmac-sha1 хеш по ключу sha1-хеша пароля от данные вида "user-agent\nexpires", где <strong>user-agent</strong> - первые 300 символов значения заголовка User-Agent запроса на загрузка файла; <strong>expires</strong> - см. выше; <strong>\n</strong> - символ перевода строки.</li>
</ul>
</blockquote>
<p>Пример формирования подписи на языке python:</p>
<pre class="literal-block">
import hmac
from hashlib import sha1
import time
secret = "password"
user_agent = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:23.0)"
expires = int(time.time()) + 60 * 5 # действителен в течение 5 минут
data = "{user_agent}\n{expires}".format(
user_agent=user_agent, expires=expires)
hash_secret = hmac.new(sha1(secret).hexdigest(), data, sha1)
# подпись, значение для заголовка X-Sendmefile-Secret-Sig
sig = "{expires}.{hash}".format(
expires=expires, hash=hash_secret.hexdigest()
)
</pre>
<p>Пример загрузки файла по запароленной ссылке с безопасной подписью:</p>
<pre class="literal-block">
$ curl https://xxx.selcdn.ru/container/upload?_ssuk=password -i -X PUT \
-H "X-Filename: my_file.txt" \
-H "X-Sendmefile-Secret-Sig: 1378910237.b795d3c13d91b4629a100d04c2b72ea81c12f233" \
-T path_to_file/my_file.txt
</pre>
<p>Для всех загруженных файлов устанавливается дополнительная информация в метаданные:</p>
<blockquote>
<ul class="simple">
<li><strong>X-Object-Meta-Origin-Filename</strong> - изначальное название файла</li>
<li><strong>X-Object-Meta-Uploaded-From-IP</strong> - ip-адрес с которого была произведена загрузка</li>
<li><strong>X-Object-Meta-Sendmefile-Session-Id</strong> - идентификатор сессии загрузки</li>
</ul>
</blockquote>
<p>Поддерживается возможность удаления "своих" загруженных файлов, осуществляется отправкой DELETE запроса на файл с обязательным указание заголовка X-Sendmefile-Session-Id. Удаление происходит при соблюдении следующих условий: значение X-Sendmefile-Session-Id совпадает со значением метаданных X-Object-Meta-Sendmefile-Session-Id файла, запрос загрузки и удаления пришел с одного ip-адреса и прошло не более 10 минут с момента загрузки. При успешном удалении файла возвращается код ответа 204. Пример запроса на удаление:</p>
<pre class="literal-block">
$ curl https://xxx.selcdn.ru/container/my_file.txt -i -X DELETE \
-H "X-Sendmefile-Session-Id: 111222"
</pre>
</div>
<div class="section" id="id20">
<h2><a class="toc-backref" href="#id1">Специальные страницы</a></h2>
<p>Настройки задаются на уровне контейнера и действует на все запросы внутрь контейнера. Поведение работает и для привязанных к контейнеру доменов.</p>
<p><strong>Индексные страницы</strong></p>
<blockquote>
<p>При анонимном GET-запросе на имя контейнера или папки внутри него, будет отдан специальный файл указанный в метаданных контейнера.</p>
<p>Настройка осуществляется отправкой PUT-запроса(создание) или POST-запроса(изменение) на контейнер с указанием заголовка <em>X-Container-Meta-Web-Index</em>. В значении заголовка нужно указать файл внутри контейнера без указания имени самого контейнера. Можно использовать режим указания строгого пути к файлу или относительного поиска. Значение должно быть заквотированно (url encode).</p>
<p>Примеры:</p>
<table border="1" class="docutils">
<colgroup>
<col width="23%" />
<col width="35%" />
<col width="42%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Web-Index</th>
<th class="head">Запрос</th>
<th class="head">Отданный файл</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>/index.html</td>
<td><p class="first">GET /container/</p>
<p class="last">GET /container/dir1/</p>
</td>
<td>/container/index.html</td>
</tr>
<tr><td rowspan="2">index.html</td>
<td>GET /container/</td>
<td>/container/index.html</td>
</tr>
<tr><td>GET /container/dir1/dir2/</td>
<td><p class="first">/container/dir1/dir2/index.html</p>
<p>или (если файла нет)</p>
<p class="last">/container/index.html</p>
</td>
</tr>
</tbody>
</table>
<p>Пример:</p>
<pre class="literal-block">
# создаем индексный файл
$ echo "<html>custom_index_file</html>" > my_index.html
# закачиваем его в хранилище
$ curl -i -XPUT https://xxx.selcdn.ru/new_container/my_index.html \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-T "./my_index.html"
> HTTP/1.1 100 Continue
> HTTP/1.1 201 Created
> etag: b302ffc3b75770453e96c1348e30eb93
> Last-Modified: Mon, 27 May 2013 14:42:04 GMT
# устанавливаем значение Web-Index для контейнера
$ curl -i -XPOST https://xxx.selcdn.ru/new_container \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Container-Meta-Web-Index: /my_index.html"
> HTTP/1.1 204 No Content
# при анонимном запросе получаем содержимое указанного файла
$ curl -i https://xxx.selcdn.ru/new_container/
> HTTP/1.1 200 OK
> last-modified: Mon, 27 May 2013 14:27:57 GMT
> etag: b302ffc3b75770453e96c1348e30eb93
> accept-ranges: bytes
> Content-Length: 31
> Content-Type: text/html
> access-control-request-method: HEAD, GET
>
> <html>custom_index_file</html>
</pre>
</blockquote>
<p><strong>Перенаправление при ошибке 404</strong></p>
<blockquote>
<p>При анонимном GET-запросе, если запрашиваемого файла нет в Хранилище, то будет отдано перенаправление (с кодом 307) на указанный в метаданных контейнера адрес.</p>
<p>Настройка осуществляется отправкой PUT или POST запроса на контейнер с указанием заголовка <em>X-Container-Meta-Web-404-Page</em>. В значении можно указывать файл внутри контейнера или внешнюю ссылку.</p>
<p>Примеры:</p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="39%" />
<col width="39%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Web-404-Redirect</th>
<th class="head">Запрос</th>
<th class="head">Перенаправление на</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>/404.html</td>
<td><p class="first">GET /container/nofile</p>
<p class="last">GET /container/dir1/nofile</p>
</td>
<td>/container/404.html</td>
</tr>
<tr><td rowspan="2">404.html</td>
<td>GET /container/nofile</td>
<td>/container/404.html</td>
</tr>
<tr><td>GET /container/dir1/dir2/nofile</td>
<td><p class="first">/container/dir1/dir2/404.html</p>
<p>или (если файла нет)</p>
<p>/container/dir1/404.html</p>
<p>или</p>
<p class="last">/container/404.html</p>
</td>
</tr>
<tr><td>http://test.test</td>
<td><p class="first">GET /container/nofile</p>
<p class="last">GET /container/dir1/nofile</p>
</td>
<td>http://test.test</td>
</tr>
</tbody>
</table>
<p>Для передачи информации о изначально запрашиваемом файле можно использовать специальные шаблонные параметры:</p>
<blockquote>
<ul class="simple">
<li><strong>{container}</strong> - имя контейнера</li>
<li><strong>{path}</strong> - путь к файлу относительно контейнера</li>
<li><strong>{qs}</strong> - параметры запроса (без начального символа "?")</li>
</ul>
</blockquote>
<p>По умолчанию, при отдаче страницы ошибки код ответа будет 404. Можно явно указать код ответа используя следующий формат:</p>
<blockquote>
<ul class="simple">
<li><path>?<code></li>
</ul>
</blockquote>
<p>, где path - путь к файлу, code - код ответа (может быть 200, 307 или 404).</p>
<p>Пример:</p>
<pre class="literal-block">
# устанавливаем значение Web-404-Page для контейнера
$ curl -i -XPOST https://xxx.selcdn.ru/new_container \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Container-Meta-Web-404-Page: /404.html?file={path}?307"
> HTTP/1.1 204 No Content
# при анонимном запросе на не существующий объект получаем редирект на указанный файл
$ curl -i https://xxx.selcdn.ru/new_container/non_exist_object
> HTTP/1.1 307 Temporary Redirect
> Location: http://xxx.selcdn.ru/404.html?file=non_exist_object
</pre>
<p>Пример отдачи содержимого страницы 404.html при 404 ошибках:</p>
<pre class="literal-block">
$ curl -i -XPOST https://xxx.selcdn.ru/new_container \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Container-Meta-Web-404-Page: /404.html?404"
</pre>
</blockquote>
<p><strong>Листинг файлов</strong></p>
<blockquote>
<p>При анонимном GET-запросе позволяет получить список папок и файлов внутри контейнера.</p>
<p>Вывод списка возможен в нескольких форматах: html (по умолчанию), json, plain.</p>
<p>Для настройки нужно отправить PUT-запрос на контейнер со следующими заголовками:</p>
<blockquote>
<ul class="simple">
<li><em>X-Container-Meta-Web-Listings</em> - значение <strong>on</strong> включает режим листинга для контейнера, <strong>off</strong> или пустое значение - выключает</li>
<li><em>X-Container-Meta-Web-Listings-CSS</em> - ссылка на файл стилей, используется для html формата вывода, не обязательная опцией</li>
<li><em>X-Container-Meta-Web-Listings-ACL</em> - список ограничения доступа, не обязательная опция</li>
</ul>
</blockquote>
<p>Дополнительные (не обязательные) параметры для получения листинга (GET запрос):</p>
<blockquote>
<ul class="simple">
<li><strong>format</strong> - формат вывода листинга (html, json, plain)</li>
<li><strong>limit</strong> - ограничение на количество папок и файлов в листинге (не более 1000)</li>
<li><strong>marker</strong> - с какого элемента продолжить вывод листинга</li>
</ul>
</blockquote>
<p>В ответе листинга доступны следующие дополнительные заголовки:</p>
<blockquote>
<ul class="simple">
<li><em>X-Listing-Show-Files</em> - количество файлов показанных в листинге</li>
<li><em>X-Listing-Show-Dirs</em> - количество папок показанных в листинге</li>
<li><em>X-Container-Object-Count</em> - всего файлов и папок в контейнере</li>
</ul>
</blockquote>
<p>Пример:</p>
<pre class="literal-block">
# включаем режим листинга для контейнера new_container
$ curl -i -XPOST https://xxx.selcdn.ru/new_container \
-H "X-Auth-Token: 285a05336fe0317beac78e84adac5f11" \
-H "X-Container-Meta-Web-Listings: on"
> HTTP/1.1 204 No Content
# получаем листинг файлов анонимным запросом (индексный файл
# либо должен быть выключен, либо нужно передать заголовок
# X-Web-Mode: listing)
$ curl -i https://xxx.selcdn.ru/new_container/ \
-H "X-Web-Mode: listing"
> HTTP/1.1 200 OK
> Content-Type: application/json; charset=UTF-8
> X-Listing-Show-Files: 4
> X-Container-Object-Count: 4
> X-Listing-Show-Dirs: 0
>
> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
> <html>
> ...
> </html>
# Еще примеры запросов:
# получаем листинг анонимным запросом с явным указание формата
$ curl http://xxx.selcdn.ru/public/?format=json
$ curl http://xxx.selcdn.ru/public/dir1/?format=plain
# ограничить количество выводимых элементов
$ curl http://xxx.selcdn.ru/public/?limit=100&format=plain
# вывести следующие 100 элементов после файла file100.jpg
$ curl http://xxx.selcdn.ru/public/images/?marker=file100.jpg&limit=100
</pre>
<p>Json формат вывода листинга:</p>
<pre class="literal-block">
/* список папок и файлов */
[
/* папки */
{
"subdir": "dir1/" /* название папки */
},
/* файлы */
{
/* имя файла: */
"name": "test.gif",
/* размер файла: */
"bytes": 964629,