RemoteGymp · API v1

Limits und Fehler

Lesen Sie jede Seite, beachten Sie die Ratenbegrenzungen und beheben Sie Fehler sicher.

  1. Ratenbegrenzungen

    Limits sind konfigurierbar. GET und /v1/operations/capabilities melden requestsPerMinute und authenticationRequestsPerMinutePerIp. Nach einem 429-Fehler berücksichtigen Sie „Retry-After“ und warten Sie länger, falls die Drosselung anhält. Batch-Lesevorgänge akzeptieren bis zu 100 IDs; einzelne Endpunkte können niedrigere Seiten- oder Nutzlastlimits haben.

  2. Lies jede Seite

    Verwenden Sie die Fortsetzungsregel für den aufgerufenen Endpunkt und behalten Sie die gleichen Filter bei. Listen können sich beim Lesen ändern; verwenden Sie Snapshots, wenn Sie eine konsistente Kopie benötigen.

    PaginierungFortfahren mitAnhalten, wenn
    Cursornext als after übergeben.Nächster Eintrag: null.
    Offset mit nextOffsetnextOffset als offset übergeben.nextOffset ist null.
    Offset mit hasMoreOffset um die Anzahl der zurückgegebenen Elemente erhöhen.hasMore ist falsch.
    SoftwareDen numerischen Wert von next als after übergeben; Neustart bei Änderung von updatedAtUtc.Nächster Eintrag: null.
    Ereignisfeednext als after übergeben.hasMore ist falsch.
  3. Fehlerbehandlung

    Fehlercode und HTTP-Status lesen. Falls die Antwort requestId enthält, diesen Wert beim Support angeben.

    HTTP-StatusWas ist zu tun?
    400Anfrage korrigieren.
    401Anmeldeinformationen prüfen oder neues Zugriffstoken anfordern.
    403Bereich, Berechtigungen und Zugriffsaktivierung prüfen.
    404Die Ressource fehlt möglicherweise oder liegt außerhalb Ihres Bereichs.
    409Lesen Sie den Fehlercode und den aktuellen Status, bevor Sie entscheiden.
    410Der Snapshot oder der Ereigniscursor ist abgelaufen. Beginnen Sie eine neue Baseline.
  4. Wenn ein Schreibvorgang ein Timeout verursacht

    Ein Timeout oder ein 503-Fehler beweist nicht, dass die Aktion fehlgeschlagen ist. Bei Schreibvorgängen, die eine Vorgangsbestätigung zurückgeben, suchen Sie vor einem erneuten Versuch in GET und /v1/operations/by-key?idempotencyKey={key} nach. Verwenden Sie für Wartungsarbeiten die ursprüngliche Idempotency-Key und den zugehörigen Body wieder.

API-Referenz →

Inhaltsüberarbeitung 3f225a253 · OpenAPI SHA-256: b12c42306a89