API のタイムアウトについて

julio.harada
Contributor

API のタイムアウトについて

Anaplan のAPI には10分タイムアウトが設けられている。

これはサーバー側でのタイムアウトであるため、クライアント側で10分以上に設定しても単一リクエストが10分経っても完了しないとタイムアウトしてしまう。

タイムアウトすると下記内容のレスポンスが戻る:

  • エラーコード524
  • レスポンスボディに "timeout occurred" といった旨のメッセージ

10分は比較的長く感じるが、10分以上要するリクエストはしばしば見られ、その要因として以下が挙げられる:

  • モデルオープン
  • モデルセーブ
  • モデルロールバック
  • 計算処理の多いインポート
  • サイズの大きいエクスポート

モデルオープンが10分以上かかるモデルは最初のリクエストで失敗しまうため、事前にダミーのリクエストを送信して、モデルをオープンしておくことが推奨される。

ダミーのリクエストはモデルを対象とするリクエストであれば内容は問われないが、比較的軽めであることが望まれる。

例、

  • プロセスの一覧取得
  • 空のプロセスを作成してそのプロセスを実行