RemoteGymp · API v1

ข้อจำกัดและข้อผิดพลาด

อ่านทุกหน้า เคารพข้อจำกัดอัตรา และกู้คืนจากข้อผิดพลาดอย่างปลอดภัย

  1. ข้อจำกัดอัตรา

    สามารถกำหนดค่าข้อจำกัดได้ GET /v1/operations/capabilities รายงาน requestsPerMinute และ authenticationRequestsPerMinutePerIp หลังจาก 429 ให้ปฏิบัติตาม Retry-After และรอให้นานขึ้นหากการจำกัดยังคงดำเนินต่อไป การอ่านแบบกลุ่มยอมรับได้สูงสุด 100 ID; ปลายทางแต่ละรายการอาจมีข้อจำกัดหน้าหรือเพย์โหลดที่น้อยกว่า

  2. อ่านทุกหน้า

    ใช้กฎการต่อเนื่องจากปลายทางที่คุณเรียกใช้ โดยคงตัวกรองเดิมไว้ รายการอาจเปลี่ยนแปลงได้ในขณะที่คุณอ่าน ให้ใช้สแนปช็อตเมื่อคุณต้องการสำเนาที่สอดคล้องกัน

    การแบ่งหน้าดำเนินการต่อด้วยหยุดเมื่อ
    เคอร์เซอร์ส่งผ่าน next เป็น afterถัดไปคือ null
    ออฟเซ็ตด้วย nextOffsetส่งผ่าน nextOffset เป็น offsetnextOffset คือ null
    ค่าชดเชยด้วย hasMoreเพิ่มค่าชดเชยตามจำนวนรายการที่ส่งคืนhasMore เป็นเท็จ
    ซอฟต์แวร์ส่งค่าตัวเลข next เป็น after; เริ่มใหม่หาก updatedAtUtc เปลี่ยนแปลงถัดไปคือ null
    ฟีดเหตุการณ์ส่งผ่าน next เป็น afterhasMore เป็นเท็จ
  3. จัดการข้อผิดพลาด

    อ่านรหัสข้อผิดพลาดและสถานะ HTTP หากการตอบกลับมี requestId ให้ระบุเมื่อติดต่อฝ่ายสนับสนุน

    สถานะ HTTPสิ่งที่ต้องทำ
    400แก้ไขคำขอ
    401ตรวจสอบข้อมูลประจำตัวหรือขอโทเค็นการเข้าถึงใหม่
    403ตรวจสอบขอบเขต สิทธิ์ และว่าการเข้าถึงเปิดใช้งานอยู่หรือไม่
    404ทรัพยากรอาจหายไปหรืออยู่นอกขอบเขตของคุณ
    409อ่านรหัสข้อผิดพลาดและสถานะปัจจุบันก่อนตัดสินใจ
    410สแนปช็อตหรือเคอร์เซอร์เหตุการณ์หมดอายุแล้ว เริ่มเบสไลน์ใหม่
  4. หากการเขียนหมดเวลา

    การหมดเวลาหรือรหัส 503 ไม่ได้หมายความว่าการดำเนินการล้มเหลว สำหรับการเขียนที่ส่งคืนใบเสร็จรับเงิน ให้ค้นหา GET /v1/operations/by-key?idempotencyKey={key} ก่อนลองใหม่ สำหรับการสร้างเพื่อการบำรุงรักษา ให้ใช้ Idempotency-Key และเนื้อหาเดิมซ้ำ

การอ้างอิง API →

3f225a253 แก้ไขเนื้อหา · OpenAPI SHA-256: b12c42306a89