RemoteGymp · API v1

Had dan ralat

Baca setiap halaman, hormati had kadar dan pulihkan dengan selamat daripada ralat.

  1. Had kadar

    Had boleh dikonfigurasikan. GET /v1/operations/capabilities melaporkan requestsPerMinute dan authenticationRequestsPerMinutePerIp. Selepas 429, hormati Cuba Semula-Selepas dan tunggu lebih lama jika pendikit berterusan. Bacaan kelompok menerima sehingga 100 ID; titik akhir individu mungkin mempunyai had halaman atau muatan yang lebih kecil. (Retry-After)

  2. Baca setiap muka surat

    Gunakan peraturan penerusan untuk titik akhir yang anda panggil, dengan mengekalkan penapis yang sama. Senarai boleh berubah semasa anda membacanya; gunakan snapshot apabila anda memerlukan salinan yang konsisten.

    Penomboran HalamanTeruskan denganHenti apabila
    KursorHantar next sebagai after.seterusnya ialah null.
    Diimbangi dengan nextOffsetHantar nextOffset sebagai offset.nextOffset ialah null.
    Diimbangi dengan hasMoreTingkatkan imbang dengan bilangan item yang dikembalikan.hasMore adalah palsu.
    PerisianHantarkan nilai next berangka sebagai after; mulakan semula jika updatedAtUtc berubah.seterusnya ialah null.
    Suapan peristiwaHantar next sebagai after.hasMore adalah palsu.
  3. Kendalikan ralat

    Baca kod ralat serta status HTTP. Jika respons tersebut merangkumi requestId, sebutkannya semasa menghubungi sokongan.

    Status HTTPApa yang perlu dilakukan
    400Betulkan permintaan.
    401Semak kelayakan atau dapatkan token akses baharu.
    403Semak skop, kebenaran dan sama ada akses diaktifkan.
    404Sumber mungkin hilang atau di luar skop anda.
    409Baca kod ralat dan keadaan semasa sebelum membuat keputusan.
    410Kursi snapshot atau peristiwa telah tamat tempoh. Mulakan garis dasar baharu.
  4. Jika masa penulisan tamat

    Tamat masa atau 503 tidak membuktikan tindakan tersebut gagal. Untuk penulisan yang mengembalikan resit operasi, cari GET /v1/operations/by-key?idempotencyKey={key} sebelum mencuba semula. Untuk penciptaan penyelenggaraan, gunakan semula Idempotency-Key dan badan asal.

Rujukan API →

Semakan kandungan 3f225a253 · OpenAPI SHA-256: b12c42306a89