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