resume
説明
宛先クラスターに保存されているデータに基づいて、一時停止した同期セッションを再開します。
要件
resume
エンドポイントを使用するには、 mongosync
が一時停止状態である必要があります。
注意
シャーディングされたクラスター間で同期するように複数のmongosync
インスタンスを構成する場合は、各mongosync
インスタンスに同一の API エンドポイント コマンドを送信する必要があります。
詳細については、「複数の Mongosync を再開する 」を参照してください。
リクエスト
POST /api/v1/resume
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体のパラメータを使用しません。 ただし、空のオブジェクト{ }
を使用して--data
オプションを指定する必要があります。
応答
フィールド | タイプ | 説明 |
---|---|---|
success | ブール値 | リクエストが成功した場合、この値は true になります。 |
error | string | エラーが発生した場合、 はエラーの名前を示します。 このフィールドは、 success がtrue の場合、応答から省略されます。 |
errorDescription | string | 発生したエラーの詳細な説明。 このフィールドは、 success がtrue の場合、応答から省略されます。 |
例
次の例では、一時停止された同期操作を再開します。
リクエスト
curl localhost:27182/api/v1/resume -XPOST --data '{ }'
応答
{"success":true}
動作
resume
リクエストを送信すると、mongosync
が移行を再開するまでに少なくとも 2 分かかる場合があります。 移行が再開されたかどうかを確認するには、progress
エンドポイントを呼び出します。resume
リクエストが成功すると、mongosync
はRUNNING
状態になります。
エンドポイント保護
mongosync
は、 resume
エンドポイントを保護しません。 ただし、デフォルトでは、API は localhost のみにバインドされ、他のソースからの呼び出しは受け入れません。 さらに、 resume
呼び出しでは接続認証情報やユーザー データは公開されません。