RemoteGymp · API v1

Korlátok és hibák

Olvasson el minden oldalt, tartsa be a sebességkorlátokat, és biztonságosan álljon helyre a hibákból.

  1. Sebességkorlátok

    A korlátok konfigurálhatók. A GET A /v1/operations/capabilities a requestsPerMinute és a authenticationRequestsPerMinutePerIp jelentését jelenti. 429 után a Retry-After értéket betartja, és hosszabb várakozást vár, ha a szabályozás folytatódik. A kötegelt olvasások akár 100 azonosítót is elfogadnak; az egyes végpontok kisebb oldal- vagy hasznos adatkorlátokkal rendelkezhetnek.

  2. Olvass el minden oldalt

    Használja a meghívott végpont folytatási szabályát, megtartva ugyanazokat a szűrőket. A listák olvasás közben változhatnak; használjon pillanatképeket, ha konzisztens másolatra van szüksége.

    OldalszámozásFolytatás ezzel:Leállítás, amikor:
    KurzorAdja át a next-t after-ként.A következő a null.
    Eltolás nextOffset-velAdja át a nextOffset-t offset-ként.A nextOffset értéke null.
    Eltolás hasMore-velNövelje az eltolást a visszaküldött elemek számával.A hasMore értéke hamis.
    SzoftverAdja át a numerikus next értéket after-ként; indítsa újra, ha a updatedAtUtc megváltozik.A következő a null.
    EseményhírcsatornaAdja át a next-t after-ként.A hasMore értéke hamis.
  3. Hibák kezelése

    Olvassa el a hibakódot és a HTTP állapotot. Ha a válasz tartalmazza a requestId-t, idézze azt, amikor kapcsolatba lép az ügyfélszolgálattal.

    HTTP állapotTeendők
    400Javítsa ki a kérést.
    401Ellenőrizze a hitelesítő adatokat, vagy szerezzen be új hozzáférési tokent.
    403Ellenőrizze a hatókört, az engedélyeket és azt, hogy a hozzáférés engedélyezve van-e.
    404Lehet, hogy az erőforrás hiányzik, vagy kívül esik a hatókörén.
    409Olvassa el a hibakódot és az aktuális állapotot, mielőtt döntene.
    410A pillanatkép vagy az eseménykurzor lejárt. Kezdjen új alapvonalat.
  4. Ha egy írás időtúllépést okoz

    Az időtúllépés vagy az 503-as hiba nem bizonyítja, hogy a művelet sikertelen volt. Az olyan írások esetében, amelyek műveleti bizonylatokat adnak vissza, keresse meg a GET /v1/operations/by-key?idempotencyKey={key} fájlt, mielőtt újra próbálkozna. Karbantartás létrehozásához használja fel újra az eredeti Idempotency-Key fájlt és a törzset.

API referencia →

Tartalom felülvizsgálata 3f225a253 · OpenAPI SHA-256: b12c42306a89