Menu dokumentacji

API zadań#

Zadania są trwałym zapisem pracy asynchronicznej. Zadania zapytań udostępniają publiczne stany queued, running, succeeded, failed i cancelled.

Lista zadań#

GET/jobs

Zwraca zadania od najnowszych. limit ma domyślną wartość 20 i przyjmuje od 1 do 100. Gdy has_more ma wartość true, przekaż next_cursor jako starting_after.

Pobieranie jednego zadania#

GET/jobs/{id}

Zwraca bieżący stan, znaczniki czasu, rodzaj i informacje o niepowodzeniu. 404 job_not_found nie rozróżnia nieznanego identyfikatora od zadania w innej organizacji.

Śledzenie zdarzeń#

GET/jobs/{id}/events

Ten strumień Server-Sent Events nadaje każdemu zdarzeniu danych stabilny, rosnący id. Połącz się ponownie z Last-Event-ID. Strumień zaleca ponowienie po 5 sekundach, sprawdza trwały stan co 3 sekundy i wysyła komentarze heartbeat co 25 sekund.

Połączenia są zamykane krótko przed 120-sekundową granicą warstwy internetowej. Połącz się ponownie i zawsze używaj GET /jobs/{id} jako rozstrzygającego stanu końcowego. Nieprawidłowy identyfikator zdarzenia zwraca 400 invalid_last_event_id.

Pobieranie wyników#

GET/jobs/{id}/result

Dla pomyślnie zakończonego zadania zapytania zwraca nowe podpisane adresy URL Parquet ważne przez 1 godzinę. Traktuj je jak sekrety zapewniające dostęp do danych.

Anulowanie#

POST/jobs/{id}/cancel

Oczekująca praca jest anulowana atomowo. Anulowanie działającego zapytania odbywa się w miarę możliwości i może zwrócić execution_may_continue: true, ponieważ praca już dopuszczona przez silnik może się jeszcze zakończyć. Odpytuj zadanie o stan końcowy.

GET /version zwraca wersję publicznego kontraktu API ogłaszaną w nagłówkach odpowiedzi.