REST APIで実行完了したかの確認方法

Question

以下のようにnameで指定したプログラムの実行状況を確認するためのREST APIがあるとします。
このとき、プログラムが完了するまで待機したいのですが、一般的にどうするものなのでしょうか？

◆API
【実行状況取得API】
GET /status?name=test
【Response】
Finish -> 実行完了
Running ->　実行中
Error -> エラー発生

自分で思いつくのは以下のように、実行中ならループし続けて、
1秒間隔でREST APIを実行する方法です。

◆簡単なソースコード（文法はあまり気にしないでください）

// getStatus()は上記APIを実行しResponseを返す関数
while(getStatus() == "Running") {
  sleep(1000)
  if (isTimeout()) {
    break;
  }
}

この方法だと、サーバに負荷がかかり過ぎないかなどを心配しています。
また、この方法をとる場合、それぐらいの頻度でREST APIを実行するのかも教えて頂けると助かります。

以上、よろしくお願いします。

Answer 1

REST APIを叩く同時クライアント数、実行プログラムの内容(負荷の元がCPU/IOどちらなのか)、ネットワーク帯域、実行状況の確認後の処理の業務優先度など複数の要件によって変わるため一般論で回答します。

1. 定期的にポーリングするのも一つの手ですが、指数関数的後退Exponential Backoffアルゴリズムがあります。

2. プログラム内でハードコーディングせずにリトライ間隔は設定情報として外部情報に保持することをお勧めします。

3. プログラム実行側(投入側)のRESET APIの戻り値を変更できるなら、泥臭い手ですがヒント情報(大凡の完了時刻）をクライアントに返すのも一つの手です。

質問文にサーバーの負荷を気にする発言があるため、
顧客要件なら要件仕様にフォールバック(縮退運転時)の仕様が記載されている気がしますが、書かれていませんか。。

Comments

[mominga]

ご回答ありがとうございます。
そういった方法もあるのですね。
今回は、処理時間がそんなにかからないようなので定期的にポーリングと思います。