`pause`

項目一覧

説明

現在の同期操作を一時停止します。

pauseエンドポイントを使用するには、 mongosyncが実行中状態である必要があります。

シャーディングされたクラスター間で同期するように複数のmongosyncインスタンスを構成する場合は、各mongosyncインスタンスに同一の API エンドポイントコマンドを送信する必要があります。

POST /api/v1/pause

このエンドポイントは、HTTP リクエスト本体のパラメータを使用しません。ただし、空のオブジェクト{ }を使用して--dataオプションを指定する必要があります。

フィールド	タイプ	説明
`success`	ブール値	リクエストが成功した場合、この値は`true`になります。
`error`	string	エラーが発生した場合、はエラーの名前を示します。このフィールドは、 `success`が`true`の場合、応答から省略されます。
`errorDescription`	string	発生したエラーの詳細な説明。このフィールドは、 `success`が`true`の場合、応答から省略されます。

次の例では、現在の同期操作を一時停止します。

curl localhost:27182/api/v1/pause -XPOST --data '{ }'

{"success":true}

mongosync は、 pauseエンドポイントを保護しません。ただし、デフォルトでは、API は localhost のみにバインドされ、他のソースからの呼び出しは受け入れません。さらに、 pause呼び出しでは接続認証情報やユーザーデータは公開されません。

戻る

進行状況

再開