RemoteGymp · API v1

Terfynau a gwallau

Darllenwch bob tudalen, parchwch derfynau cyfradd ac adferwch yn ddiogel o wallau.

  1. Terfynau cyfradd

    Mae terfynau'n ffurfweddadwy. Mae GET /v1/operations/capabilities yn adrodd requestsPerMinute a authenticationRequestsPerMinutePerIp. Ar ôl 429, anrhydeddwch Ail-Geisio-Ar ôl ac aros yn hirach os yw'r cyfyngiad yn parhau. Mae darlleniadau swp yn derbyn hyd at 100 o IDau; gall terfynau unigol fod â therfynau tudalen neu lwyth tâl llai. (Retry-After)

  2. Darllen pob tudalen

    Defnyddiwch y rheol barhad ar gyfer y terfyn a alwoch, gan gadw'r un hidlwyr. Gall rhestrau newid wrth i chi eu darllen; defnyddiwch gipluniau pan fydd angen copi cyson arnoch.

    TudalennuParhau gydaStopio pan
    CyrswrPasio next fel after.nesaf yw null.
    Gwrthbwyso gyda nextOffsetPasio nextOffset fel offset.nextOffset yw null.
    Gwrthbwyso gyda hasMoreCynyddu'r gwrthbwyso gan nifer yr eitemau a ddychwelwyd.Mae hasMore yn ffug.
    MeddalweddPasiwch y gwerth rhifol next fel after; ailgychwyn os bydd updatedAtUtc yn newid.nesaf yw null.
    Porthiant digwyddiadauPasio next fel after.Mae hasMore yn ffug.
  3. Trin gwallau

    Darllenwch y cod gwall yn ogystal â'r statws HTTP. Os yw'r ymateb yn cynnwys requestId, dyfynnwch ef wrth gysylltu â chymorth.

    Statws HTTPBeth i'w wneud
    400Trwsio'r cais.
    401Gwirio'r manylion mewngofnodi neu gael tocyn mynediad newydd.
    403Gwirio cwmpas, caniatâd ac a yw mynediad wedi'i alluogi.
    404Efallai bod yr adnodd ar goll neu y tu allan i'ch cwmpas.
    409Darllenwch y cod gwall a'r cyflwr cyfredol cyn penderfynu.
    410Daeth y ciplun neu'r cyrchwr digwyddiad i ben. Dechreuwch linell sylfaen newydd.
  4. Os bydd ysgrifennu'n dod i ben amser

    Nid yw terfyn amser neu 503 yn profi bod y weithred wedi methu. Ar gyfer ysgrifennu sy'n dychwelyd derbynebau gweithrediad, chwiliwch am GET /v1/operations/by-key?idempotencyKey={key} cyn ailgeisio. Ar gyfer creu cynnal a chadw, ailddefnyddio'r Idempotency-Key a'r corff gwreiddiol.

Cyfeirnod API →

Adolygiad cynnwys 3f225a253 · OpenAPI SHA-256: b12c42306a89