RemoteGymp · API v1

制限とエラー

すべてのページを読み取り、レート制限を遵守し、エラーから安全に回復してください。

  1. レート制限

    制限は設定可能です。GETと/v1/operations/capabilitiesはrequestsPerMinuteとauthenticationRequestsPerMinutePerIpを報告します。429エラー発生後、Retry-Afterオプションを尊重し、スロットリングが継続する場合はさらに待機してください。バッチ読み取りは最大100個のIDを受け入れます。個々のエンドポイントには、より少ないページまたはペイロード制限が設定されている場合があります。

  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