REST API

API OCS jest w pełni zgodne ze Swift Object Storage z pakietu OpenStack. Po poprawnej autoryzacji w dostępie do usługi, można korzystać z OCS używając identycznej składni zapytań.

Oficjalna dokumentacja OpenStacka Object Storage API w języku angielskim znajduje się tutaj.

Kontenery

get
Listowanie wszystkich kontenerów na koncie

https://ocs-pl.oktawave.com/v1/STORAGEURL
Listowanie wszystkich kontenerów na koncie: curl -X GET -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL?format=json' -H 'X-Auth-Token: TOKEN'
Request
Response
Request
Path Parameters
format
required
string
json
Headers
X-Auth-Token
required
string
TOKEN
Response
200: OK

Aby pobrać listę wszystkich kontenerów należy utworzyć token podając dane uwierzytelniające należące do użytkownika posiadającego rolę administratora.

put
Dodanie nowego kontenera

https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER?format=json
Żądanie dodania nowego kontenera ma następującą postać: curl -X PUT -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER?format=json' -H 'X-Auth-Token: TOKEN'
Request
Response
Request
Path Parameters
KONTENER
required
string
Nazwa kontenera
STORAGEURL
required
string
Wygenerowany w metodzie pobierania tokena.
Headers
X-Auth-Token
required
string
Token wygenerowany w metodzie pobierania tokena
Query Parameters
format
optional
string
Format wygenerowanej odpowiedzi: json|xml|text
Response
201: Created

delete
Usuwanie kontenera

https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER
Usunięcie pustego kontenera: curl -X DELETE -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER?format=json' -H 'X-Auth-Token: TOKEN'
Request
Response
Request
Path Parameters
STORAGEURL
required
string
Wygenerowany w metodzie pobierania tokena
KONTENER
required
string
Nazwa kontenera
Headers
X-Auth-Token
required
string
Token wygenerowany w metodzie pobierania tokena
Response
204: No Content

head
Pobieranie metadanych

https://pl-ocs.oktawave.com/v1/STORAGEURL/KONTENER?format=json
Pokazuje metadane, na przykład liczbę obiektów lub liczbę bajtów we wszystkich obiektach w kontenerze. Wyświetlanie metadanych: curl -X HEAD -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER?format=json' -H 'X-Auth-Token: TOKEN'
Request
Response
Request
Path Parameters
KONTENER
required
string
Nazwa kontenera
Headers
X-Auth-Token
optional
string
Token wygenerowany w metodzie pobierania tokena
Response
204: No Content

post
Aktualizacja metadanych

https://pl-ocs.oktawave.com/v1/STORAGEURL/KONTENER
Tworzy, aktualizuje lub usuwa metadane dla kontenera : X -Container-Meta-{name} , gdzie{name} to nazwa parametru. Tworzenie/aktualizacja/usuwanie metadanych: curl -X POST -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER?format=json' -H 'X-Auth-Token: TOKEN' -H "X-Container-Meta-Author: AUTOR" -H "X-Container-Meta-Web-Directory-Type: text/directory"
Request
Response
Request
Path Parameters
KONTENER
required
string
Nazwa kontenera
Headers
X-Auth-Token
optional
string
Token wygenerowany w metodzie pobierania tokena
Response
204: No Content

Obiekty

get
Pobieranie zawartości obiektu i metadanych

https://pl-ocs.oktawave.com/v1/STORAGEURL/KONTENER
Pobieranie zawartości i metadanych: curl -X GET -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER/OBIEKT?format=json' -H 'X-Auth-Token: TOKEN'
Request
Response
Request
Path Parameters
OBIEKT
required
string
Nazwa obiektu
KONTENER
required
string
Nazwa kontenera
Response
200: OK

put
Tworzenie obiektu

https://pl-ocs.oktawave.com/v1/STORAGEURL/KONTENER
Tworzy lub nadpisuje obiekt: X-Object-Meta-name , gdzie name to nazwa obiektu Tworzenie lub przenoszenie: curl -X PUT -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER/OBIEKT?format=json' -H 'X-Auth-Token: TOKEN' -d 'Zawartość' -H "Content-Type: text/html; charset=UTF-8" Wysyłanie obiektu: curl -X PUT -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER/OBIEKT?format=json' -H 'X-Auth-Token: TOKEN' -T 'PLIK.TXT' Kopiowanie: curl -X COPY -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER/OBIEKT?format=json' -H 'X-Auth-Token: TOKEN' -H "Destination: KONTENER_DOCELOWY/OBIEKT_DOCELOWY"
Request
Response
Request
Path Parameters
KONTENER
required
string
Nazwa kontenera
OBIEKT
required
string
Nazwa obiektu
Response
201: Created

delete
Usuwanie obiektu

https://pl-ocs.oktawave.com/v1/STORAGEURL/KONTENER?format=json
Permanentnie usuwa obiekt: curl -X DELETE -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER/OBIEKT?format=json' -H 'X-Auth-Token: TOKEN'
Request
Response
Request
Path Parameters
KONTENER
required
string
Nazwa kontenera
OBIEKT
required
string
Nazwa obiektu
Response
204: No Content

head
Pobieranie metadanych

https://pl-ocs.oktawave.com/v1/STORAGEURL/KONTENER?format=json
Pokazuje metadane obiektu: curl --head 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER/OBIEKT?format=json' -H 'X-Auth-Token: TOKEN'
Request
Response
Request
Path Parameters
KONTENER
required
string
Nazwa kontenera
OBIEKT
required
string
Nazwa obiektu
Response
200: OK

post
Aktualizacja metadanych

https://pl-ocs.oktawave.com/v1/STORAGEURL/KONTENER
Wysyłanie i aktualizacja metadanych: curl -X POST -i 'https://ocs-pl.oktawave.com/v1/STORAGEURL/KONTENER/OBIEKT?format=json' -H 'X-Auth-Token: TOKEN' -H "X-Object-Meta-KSIAZKA: TYTUL_KSIAZKI"
Request
Response
Request
Path Parameters
KONTENER
required
string
Nazwa kontenera
Response
202: Accepted