curl
). Większość języków programowania posiada gotowe biblioteki do używania REST API.
Aby przetestować API Oktawave można użyć udostępnionych przez Oktawave implementacji klienta Swagger. Po autoryzacji użytkownika można wywołać tam wszystkie zasoby, sprawdzić jak w czasie rzeczywistym odpowiada API i jak są zdefiniowane przykładowe żądania.Accept
w żądaniu (application/json
, application/xml
, text/json
i text/xml
). Poniżej lista podstawowych nagłówków przesyłanych w odpowiedzi przez serwer:Content-Type
- format odpowiedzi,Content-Length
- długość odpowiedzi,X-Rate-Limit-Limit
- łączny limit zapytań nałożony na dane konto w wybranej jednostce czasu,X-Rate-Limit-Remaining
- pozostały limit zapytań nałożony na dane konto w wybranej jednostce czasu,X-Rate-Limit-Reset
- pozostały czas w milisekundach do zresetowania limitu.fields
- pozwala na przekazanie listy pól zasobu, które mają być zwrócone - wielkość liter jest ignorowana,query
- przekazany ciąg znaków zostanie wyszukany w zawartości zasobu i zostaną zwrócone jedynie te spełniające zapytanie./instances
) zwracają kolekcję do pierwszych 50 obiektów danego zasobu, wraz z dołączonymi metadanymi. Kolekcja spełnia dodatkowe funkcje:pageSize
- ustawia niestandardową liczbę obiektów na stronie oraz pageNumber
- pozwala wybrać numer strony,total
oznaczające liczbę wszystkich obiektów w kolekcji./instances/{id}/autoscaler/enable_ticket
zwraca w odpowiedzi zlecenie./tickets/{id}
. W odpowiedzi otrzymamy zlecenie zawierające dane takie jak: