RemoteGymp · API v1

Batasan dan kesalahan

Baca setiap halaman, patuhi batasan laju, dan pulihkan dengan aman dari kesalahan.

  1. Batasan laju

    Batasan dapat dikonfigurasi. GET /v1/operations/capabilities melaporkan requestsPerMinute dan authenticationRequestsPerMinutePerIp. Setelah kode kesalahan 429, patuhi Retry-After dan tunggu lebih lama jika pembatasan terus berlanjut. Pembacaan batch menerima hingga 100 ID; titik akhir individual mungkin memiliki batasan halaman atau muatan yang lebih kecil.

  2. Baca setiap halaman

    Gunakan aturan kelanjutan untuk titik akhir yang Anda panggil, dengan tetap menggunakan filter yang sama. Daftar dapat berubah saat Anda membacanya; gunakan snapshot saat Anda membutuhkan salinan yang konsisten.

    Penomoran halamanLanjutkan denganBerhenti saat
    KursorLewatkan next sebagai after.Berikutnya adalah null.
    Offset dengan nextOffsetLewatkan nextOffset sebagai offset.nextOffset adalah null.
    Offset dengan hasMoreTingkatkan offset sebanyak jumlah item yang dikembalikan.hasMore bernilai false.
    Perangkat LunakTeruskan nilai numerik next sebagai after; mulai ulang jika updatedAtUtc berubah.Berikutnya adalah null.
    Umpan PeristiwaLewatkan next sebagai after.hasMore bernilai false.
  3. Tangani kesalahan

    Baca kode kesalahan serta status HTTP. Jika respons menyertakan requestId, sebutkan saat menghubungi dukungan.

    Status HTTPApa yang harus dilakukan
    400Perbaiki permintaan.
    401Periksa kredensial atau dapatkan token akses baru.
    403Periksa cakupan, izin, dan apakah akses diaktifkan.
    404Sumber daya mungkin hilang atau di luar cakupan Anda.
    409Baca kode kesalahan dan status saat ini sebelum mengambil keputusan.
    410Snapshot atau kursor peristiwa telah kedaluwarsa. Mulai baseline baru.
  4. Jika penulisan mengalami timeout

    Timeout atau 503 tidak membuktikan tindakan gagal. Untuk penulisan yang mengembalikan tanda terima operasi, cari GET /v1/operations/by-key?idempotencyKey={key} sebelum mencoba lagi. Untuk pembuatan pemeliharaan, gunakan kembali Idempotency-Key dan isi asli.

Referensi API →

Revisi konten 3f225a253 · OpenAPI SHA-256: b12c42306a89