RemoteGymp · API v1

Mipaka na hitilafu

Soma kila ukurasa, heshimu mipaka ya kiwango na upone salama kutokana na hitilafu.

  1. Mipaka ya kiwango

    Mipaka inaweza kusanidiwa. GET /v1/operations/capabilities inaripoti requestsPerMinute na authenticationRequestsPerMinutePerIp. Baada ya 429, heshimu Jaribu-Baada ya Upya na usubiri kwa muda mrefu zaidi ikiwa kukandamiza kutaendelea. Kundi linasoma kukubali hadi vitambulisho 100; sehemu za mwisho za mtu binafsi zinaweza kuwa na mipaka midogo ya ukurasa au mzigo. (Retry-After)

  2. Soma kila ukurasa

    Tumia sheria ya mwendelezo kwa sehemu ya mwisho uliyoita, ukiweka vichujio sawa. Orodha zinaweza kubadilika unapozisoma; tumia picha za haraka unapohitaji nakala thabiti.

    Upaji wa UkurasaEndelea naSimamisha wakati
    KishalePitisha next kama after.inayofuata ni null.
    Imezimwa na nextOffsetPitisha nextOffset kama offset.nextOffset ni null.
    Imebadilishwa na hasMoreOngeza upunguzaji kwa idadi ya vipengee vilivyorejeshwa.hasMore si kweli.
    ProgramuFanya thamani ya nambari ya next kama after; anza upya ikiwa updatedAtUtc itabadilika.inayofuata ni null.
    Mlisho wa matukioPitisha next kama after.hasMore si kweli.
  3. Shughulikia hitilafu

    Soma msimbo wa hitilafu pamoja na hali ya HTTP. Ikiwa jibu linajumuisha requestId, nukuu unapowasiliana na usaidizi.

    Hali ya HTTPCha kufanya
    400Rekebisha ombi.
    401Angalia vitambulisho au pata tokeni mpya ya ufikiaji.
    403Angalia upeo, ruhusa na kama ufikiaji umewezeshwa.
    404Huenda rasilimali hiyo ikakosekana au nje ya wigo wako.
    409Soma msimbo wa hitilafu na hali ya sasa kabla ya kuamua.
    410Picha au kielekezi cha tukio kimeisha muda. Anza msingi mpya.
  4. Ikiwa muda wa kuandika umeisha

    Muda wa kuisha au 503 hauthibitishi kuwa kitendo kimeshindwa. Kwa maandishi kwamba risiti za operesheni ya kurudisha, angalia GET /v1/operations/by-key?idempotencyKey={key} kabla ya kujaribu tena. Kwa uundaji wa matengenezo, tumia tena Idempotency-Key na mwili wa asili.

Marejeo ya API →

Marekebisho ya yaliyomo 3f225a253 · OpenAPI SHA-256: b12c42306a89