RemoteGymp · API v1

Giới hạn và lỗi

Đọc mọi trang, tuân thủ giới hạn tốc độ và phục hồi an toàn khỏi lỗi.

  1. Giới hạn tốc độ

    Giới hạn có thể cấu hình. GET /v1/operations/capabilities báo cáo requestsPerMinute và authenticationRequestsPerMinutePerIp. Sau lỗi 429, hãy tuân thủ Retry-After và chờ lâu hơn nếu việc điều tiết vẫn tiếp tục. Đọc theo lô chấp nhận tối đa 100 ID; các điểm cuối riêng lẻ có thể có giới hạn trang hoặc tải trọng nhỏ hơn.

  2. Đọc từng trang

    Sử dụng quy tắc tiếp tục cho điểm cuối bạn đã gọi, giữ nguyên các bộ lọc. Danh sách có thể thay đổi trong khi bạn đọc chúng; hãy sử dụng ảnh chụp nhanh khi bạn cần một bản sao nhất quán.

    Phân trangTiếp tục vớiDừng khi
    Con trỏTruyền next dưới dạng after.tiếp theo là null.
    Bù trừ với nextOffsetTruyền nextOffset dưới dạng offset.nextOffset là null.
    Bù trừ với hasMoreTăng bù trừ bằng số lượng mục được trả về.hasMore là sai.
    Phần mềmTruyền giá trị số next dưới dạng after; khởi động lại nếu updatedAtUtc thay đổi.tiếp theo là null.
    Luồng sự kiệnTruyền next dưới dạng after.hasMore là sai.
  3. Xử lý lỗi

    Đọc mã lỗi cũng như trạng thái HTTP. Nếu phản hồi bao gồm requestId, hãy trích dẫn mã này khi liên hệ với bộ phận hỗ trợ.

    Trạng thái HTTPViệc cần làm
    400Sửa yêu cầu.
    401Kiểm tra thông tin xác thực hoặc lấy mã truy cập mới.
    403Kiểm tra phạm vi, quyền hạn và xem quyền truy cập có được bật hay không.
    404Tài nguyên có thể bị thiếu hoặc nằm ngoài phạm vi của bạn.
    409Hãy đọc mã lỗi và trạng thái hiện tại trước khi quyết định.
    410Con trỏ ảnh chụp nhanh hoặc sự kiện đã hết hạn. Hãy bắt đầu một đường cơ sở mới.
  4. Nếu thao tác ghi bị hết thời gian chờ

    Thời gian chờ hoặc lỗi 503 không chứng minh hành động đã thất bại. Đối với các thao tác ghi trả về biên nhận hoạt động, hãy tra cứu GET /v1/operations/by-key?idempotencyKey={key} trước khi thử lại. Để tạo bản ghi bảo trì, hãy sử dụng lại Idempotency-Key và nội dung gốc.

Tham khảo API →

3f225a253 sửa đổi nội dung · OpenAPI SHA-256: b12c42306a89