RemoteGymp · API v1

Limits i błędy

Odczytuj każdą stronę, przestrzegaj limitów przepustowości i bezpiecznie odzyskuj dane po błędach.

  1. Limits przepustowości

    Limits są konfigurowalne. GET /v1/operations/capabilities zgłasza requestsPerMinute i authenticationRequestsPerMinutePerIp. Po błędach 429 respektuj opcję Retry-Aft i odczekaj dłużej, jeśli ograniczenie przepustowości nadal występuje. Odczyty wsadowe akceptują do 100 identyfikatorów; poszczególne punkty końcowe mogą mieć mniejsze limity stron lub danych. (Retry-After)

  2. Przeczytaj każdą stronę

    Użyj reguły kontynuacji dla wywołanego punktu końcowego, zachowując te same filtry. Listy mogą się zmieniać podczas odczytu; użyj migawek, gdy potrzebujesz spójnej kopii.

    PaginacjaKontynuuj zZatrzymaj, gdy
    KursorPrzekaż next jako after.Następny to null.
    Przesunięcie z nextOffsetPrzekaż nextOffset jako offset.nextOffset to null.
    Przesunięcie o hasMoreZwiększ przesunięcie o liczbę zwróconych elementów.hasMore ma wartość false.
    OprogramowaniePrzekaż wartość liczbową next jako after; uruchom ponownie, jeśli updatedAtUtc ulegnie zmianie.Następny to null.
    Kanał zdarzeńPrzekaż next jako after.hasMore ma wartość false.
  3. Obsługa błędów

    Odczytaj kod błędu oraz status HTTP. Jeśli odpowiedź zawiera kod requestId, podaj go podczas kontaktu z pomocą techniczną.

    Status HTTPCo zrobić
    400Napraw żądanie.
    401Sprawdź dane uwierzytelniające lub uzyskaj nowy token dostępu.
    403Sprawdź zakres, uprawnienia i czy dostęp jest włączony.
    404Zasób może być nieobecny lub znajdować się poza Twoim zakresem.
    409Przed podjęciem decyzji przeczytaj kod błędu i aktualny stan.
    410Migawka lub kursor zdarzeń wygasł. Rozpocznij nową linię bazową.
  4. Jeśli upłynął limit czasu zapisu

    Upływ limitu czasu lub błąd 503 nie dowodzi, że akcja się nie powiodła. W przypadku zapisów zwracających potwierdzenia operacji, wyszukaj GET /v1/operations/by-key?idempotencyKey={key} przed ponowną próbą. W przypadku tworzenia w celach konserwacyjnych ponownie użyj oryginalnego Idempotency-Key i treści.

Referencje API →

Zmiany treści 3f225a253 · OpenAPI SHA-256: b12c42306a89