RemoteGymp · API v1

限制和錯誤

讀取每一頁,遵守速率限制,並安全地從錯誤中恢復。

  1. 速率限制

    限制可配置。 GET 和 /v1/operations/capabilities 會報告 requestsPerMinute 和 authenticationRequestsPerMinutePerIp。如果出現 429 錯誤,請遵循「重試後」策略,如果仍然受到限制,請等待更長時間。批次讀取最多可接受 100 個 ID;單一端點的頁面或有效負載限制可能更小。 (Retry-After)

  2. 閱讀每一頁

    使用您所呼叫的端點的延續規則,並保持相同的篩選條件。清單在您讀取時可能會發生變化;當您需要一致的副本時,請使用快照。

    分頁繼續讀取停止讀取
    遊標將 next 作為 after 傳遞。下一個是 null。
    偏移量為 nextOffset將 nextOffset 作為 offset 傳遞。nextOffset 等於 null。
    使用 hasMore 進行偏移偏移量增加返回項的數量。hasMore 為 false。
    軟體將數值 next 作為 after 傳遞;如果 updatedAtUtc 發生變化,則重新啟動。下一個是 null。
    活動饋送將 next 作為 after 傳遞。hasMore 為 false。
  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