`progress`

項目一覧

説明

リクエスト
応答
正常な応答
エラー応答
動作
エンドポイント保護
例
リクエスト
応答

説明

同期プロセスの更新されたステータスまたはエラーを返します。

リクエスト

GET /api/v1/progress

応答

progressエンドポイントは更新されたステータスまたはエラーのいずれかを返します。

正常な応答

応答オブジェクトには、 2の最上位フィールド、 successとprogressが含まれています。

successフィールドには、 progressコマンドのステータスが含まれます。常にtrueの場合、値はtrueです。

mongosyncが同期プロセスのステータスを正常に取得すると、すべての応答フィールドは次のフィールドを持つ最上位のprogressオブジェクトにラップされます。

フィールド	タイプ	説明
`state`	string	`mongosync`の現在の状態。利用可能な状態の詳細については、「状態の説明」を参照してください。
`canCommit`	ブール値	`true`の場合、コミットリクエストが成功することを示します。これは、最初の同期が完了し、変更イベントが適用されていることも意味します。
`canWrite`	ブール値	`true`の場合、は、宛先クラスターで書込み（write）が許可されていることを示します。 Do not write to the destination cluster while `canWrite` is `false`. インデックスの検証は、コミットが完了するまで続きます。
`info`	string	同期の進行状況に関する追加情報を提供します。可能な`info`値は次のとおりです。 `"collection copy"` `"change event application"` `"waiting for commit to complete"` `"commit completed"`
`lagTimeSeconds`	integer	`mongosync`が宛先クラスターに適用した最新のイベントタイムスタンプと、 `mongosync`のこのインスタンスのソースクラスターの最新タイムスタンプとの間の時間差（秒単位）。 `mongosync` はソースクラスターに対して定期的にノーオペレーション（no-op）書込みを実行するため、 `mongosync` `lagTimeSeconds`フィールドの値が 0 にならない可能性があります。ソースクラスターでは継続的な何も操作が行われないため、ソースクラスターで実際に書込み (write) が行われていない場合でも、時間差は 0 数秒を超えることが多いです。 `mongosync`が移行をコミットすると、時間差は 0 になります。
`totalEventsApplied`	integer	`mongosync`のこのインスタンスが宛先クラスターに適用した変更イベントのおおよその数。この値は永続化されず、カウントから特定のイベントが省略されるため、イベントの総数を正確に表さない可能性があります。
`collectionCopy`	オブジェクト	コレクションからコピーされるデータの合計量と、宛先クラスターにすでにコピーされたデータ量を見積もります
`collectionCopy` `.estimatedTotalBytes`	integer	コレクションの初期コピー中にすべての`mongosync`インスタンスによってグローバルにコピーされる推定合計バイト数。 `mongosync` は、移行前に推定される合計バイト数を近似し、同期プロセス中にこの値を更新しません。この値は、同期中にソースクラスターに加えられた変更を反映していないため、移行の進行状況を正確に示すものではありません。
`collectionCopy` `.estimatedCopiedBytes`	integer	コレクションの初期コピー中にこの`mongosync`インスタンスによって宛先クラスターにコピーされた推定バイト数。推定される進行状況の合計をパーセンテージとして計算するには、各`mongosync`インスタンスの`estimatedCopiedBytes`フィールドの値を加算し、その結果を`estimatedTotalBytes`フィールドの値で割ります。次に、結果に 100 を掛けます。操作の再試行により、 `estimatedCopiedBytes`の値は`estimatedTotalBytes`の値より大きくなる可能性があります。 `estimatedTotalBytes`と`estimatedCopiedBytes`の比較は、移行の進行状況を示す正確なインジケーターではありません。
`directionMapping`	オブジェクト	同期のマッピング方向（ソースクラスターと宛先クラスター）を説明します。
`directionMapping` `.Source`	string	ソースクラスター。 `<cluster name>: <host>:<port>`の形式で返されます。
`directionMapping` `.Destination`	string	宛先クラスター。 `<cluster name>: <host>:<port>`の形式で返されます。
`mongosyncID`	string	`mongosync` インスタンスの識別子string 。バージョン 1.3 で追加。
`coordinatorID`	string	コーディネーターインスタンスの識別子 string。 `mongosync` が別のインスタンスによって調整されている場合、このフィールドにはコーディネーターインスタンスの識別子stringが表示されます。 `mongosync`がコーディネーターであるか、単独で実行されている場合、このフィールドは`mongosyncID`フィールドと同じ値を返します。 `mongosync`が起動すると、 `mongosync`がコーディネーターを識別するまで、このフィールドは`null`を返します。バージョン 1.3 で追加。
`verification`	ドキュメント	埋め込み検証子によって実行される検証チェックのフェーズと進行状況に関する情報を提供します。バージョン 1.9 の新機能。
`verification.source`	ドキュメント	ソースクラスターで実行中されている検証チェックのフェーズと進行状況に関する情報を提供します。バージョン 1.9 の新機能。
`verification.source.` `estimatedDocumentCount`	integer	ソースクラスター上のドキュメントの推定数。バージョン 1.9 の新機能。
`verification.source.` `hashedDocumentCount`	integer	ソースクラスター上の検証者によってハッシュされたドキュメントの数。バージョン 1.9 の新機能。
`verification.source.` `lagTimeSeconds`	integer	ソースクラスターで最後の検証チェックが実行された後の時間（秒単位）。バージョン 1.9 の新機能。
`verification.source.` `phase`	string	ソースクラスター上の検証プロセスの現在のフェーズ。バージョン 1.9 の新機能。
`verification.source.` `scannedCollectionCount`	integer	ソースクラスター上の埋め込み検証子によってスキャンされたコレクションの数。バージョン 1.9 の新機能。
`verification.source.` `totalCollectionCount`	integer	検証チェックに含めるソースクラスター上のコレクションの数。
`verification.destination`	ドキュメント	宛先クラスターで実行中されている検証チェックのフェーズと進行状況に関する情報を提供します。バージョン 1.9 の新機能。
`verification.destination.` `estimatedDocumentCount`	integer	宛先クラスター上の推定ドキュメント数。バージョン 1.9 の新機能。
`verification.destination.` `hashedDocumentCount`	integer	宛先クラスター上の検証子によってハッシュされたドキュメントの数。バージョン 1.9 の新機能。
`verification.destination.` `lagTimeSeconds`	integer	宛先クラスターで最後に検証チェックが実行された以降の時間（秒単位）。バージョン 1.9 の新機能。
`verification.destination.` `phase`	string	宛先クラスター上の検証プロセスの現在のフェーズ。バージョン 1.9 の新機能。
`verification.destination.` `scannedCollectionCount`	integer	宛先クラスターの埋め込み検証子によってスキャンされたコレクションの数。バージョン 1.9 の新機能。
`verification.destination.` `totalCollectionCount`	integer	検証チェックに含める宛先クラスター上のコレクションの数。バージョン 1.9 の新機能。

エラー応答

mongosyncでエラーが発生した場合、 progressエンドポイントは次のフィールドを返します。

フィールド	タイプ	説明
`success`	ブール値	`progress`コマンドのステータス。値は、コマンドが成功した場合は`true`で、コマンドが失敗した場合は`false`です。
`error`	string	エラーのタイプ。
`errorDescription`	string	エラーの詳細な説明。

動作

mongosyncがIDLE状態にある場合、 stateとcanCommitを除くすべての出力フィールドはnullになります。
mongosyncがPAUSED状態にある場合、 lagTimeSecondsフィールドはnullです。
エンドポイントは自動更新されません。更新されたステータスを取得するには、 progressエンドポイントを再度呼び出します。
mongosyncがコレクションコピーフェーズに達する前に/progressを呼び出すと、 estimatedCopiedBytesには0が、 estimatedTotalBytesには1が返されます。
estimatedTotalBytes ソースクラスターでドキュメントが挿入または削除された場合、コレクションのコピーフェーズ中に変更される可能性があります。
estimatedCopiedBytes はestimatedTotalBytesより大きくはありません。コレクションコピーフェーズの終了時に進行状況が100 % に達しました（ estimatedCopiedBytes = estimatedTotalBytes ）。
以前のバージョンから1.8.0以降へのライブアップグレードを実行する場合、コレクションのコピーデータは[0 bytes copied / 1 bytes total]から開始されます。ライブアップグレード後、 /progressはアップグレード完了後にコピーされたデータの進行状況のみを報告します。
注意
mongosync 1.7.3以降、同期操作を再開または再開する際に、 mongosyncが応答するまでに少なくとも 2 分かかる場合があります。この間、 progressエンドポイントへの呼び出しが失敗する可能性があります。 progress呼び出しが失敗した場合は、安全に再試行できます。

エンドポイント保護

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

例

次の例では、同期プロセスのステータスを返します。

リクエスト

curl localhost:27182/api/v1/progress -XGET

応答

{
   "progress":
      {
         "state":"RUNNING",
         "canCommit":true,
         "canWrite":false,
         "info":"change event application",
         "lagTimeSeconds":0,
         "collectionCopy":
            {
               "estimatedTotalBytes":694,
               "estimatedCopiedBytes":694
            },
         "directionMapping":
            {
               "Source":"cluster0: localhost:27017",
               "Destination":"cluster1: localhost:27018"
            },
         "verification":
            {
               "source":
                  {
                     "estimatedDocumentCount": 42,
                     "hashedDocumentCount": 42,
                     "lagTimeSeconds": 2,
                     "totalCollectionCount": 42,
                     "scannedCollectionCount": 10,
                     "phase": "stream hashing"
                  },
               "destination": {
                     "estimatedDocumentCount": 42,
                     "hashedDocumentCount": 42,
                     "lagTimeSeconds": 2,
                     "totalCollectionCount": 42,
                     "scannedCollectionCount": 10,
                     "phase": "stream hashing"
               }
            }
      },
   "success": true
}

戻る

始める

pause

説明

リクエスト

応答

正常な応答

エラー応答

動作

注意

エンドポイント保護

例

リクエスト

応答