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