RemoteGymp · API v1

Mga limitasyon at error

Basahin ang bawat pahina, igalang ang mga limitasyon sa rate at ligtas na makabawi mula sa mga error.

  1. Mga limitasyon sa rate

    Maaaring i-configure ang mga limitasyon. Iniuulat ng GET ang /v1/operations/capabilities sa requestsPerMinute at authenticationRequestsPerMinutePerIp. Pagkatapos ng 429, igalang ang Retry-After at maghintay nang mas matagal kung magpapatuloy ang throttling. Tumatanggap ang mga batch read ng hanggang 100 ID; maaaring may mas maliit na limitasyon sa pahina o payload ang mga indibidwal na endpoint.

  2. Basahin ang bawat pahina

    Gamitin ang continuation rule para sa endpoint na tinawag mo, at panatilihin ang parehong mga filter. Maaaring magbago ang mga listahan habang binabasa mo ang mga ito; gumamit ng mga snapshot kapag kailangan mo ng pare-parehong kopya.

    PaginationMagpatuloy gamit angHuminto kapag
    CursorIpasa ang next bilang after.Ang susunod ay null.
    Offset gamit ang nextOffsetIpasa ang nextOffset bilang offset.Ang nextOffset ay null.
    I-offset gamit ang hasMoreDagdagan ang offset ayon sa bilang ng mga ibinalik na item.Ang hasMore ay mali.
    SoftwareIpasa ang numeric na halaga ng next bilang after; i-restart kung magbago ang updatedAtUtc.Ang susunod ay null.
    Event feedIpasa ang next bilang after.Ang hasMore ay mali.
  3. Hawak ang mga error

    Basahin ang error code pati na rin ang HTTP status. Kung kasama sa tugon ang requestId, banggitin ito kapag nakikipag-ugnayan sa suporta.

    Katayuan ng HTTPAno ang gagawin
    400Ayusin ang kahilingan.
    401Suriin ang mga kredensyal o kumuha ng bagong access token.
    403Suriin ang saklaw, mga pahintulot at kung pinagana ang access.
    404Maaaring nawawala o wala sa iyong saklaw ang resource.
    409Basahin ang error code at kasalukuyang estado bago magdesisyon.
    410Nag-expire na ang snapshot o event cursor. Magsimula ng bagong baseline.
  4. Kung nag-timeout ang isang write

    Hindi pinapatunayan ng timeout o 503 na nabigo ang aksyon. Para sa mga write na nagbabalik ng mga resibo ng operasyon, hanapin ang GET /v1/operations/by-key?idempotencyKey={key} bago subukan muli. Para sa paggawa ng maintenance, gamitin muli ang orihinal na Idempotency-Key at katawan.

Sanggunian ng API →

Rebisyon ng nilalaman 3f225a253 · OpenAPI SHA-256: b12c42306a89