AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

プロセスのライフサイクルを管理する

Ops Manager API を使用すると、MongoDB プロセスのシャットダウン、起動、再起動、および再同期を実行できます。これらの操作は、ダウンタイムをシミュレートする耐障害性テストや、計画的なメンテナンス再起動時に役立ちます。また、長時間のシャットダウン後に同期が遅れてしまったメンバーを再同期することもできます。

リクエストを送信すると、Ops Manager は直ちにそのホスト上で実行されているオートメーション エージェントに、MongoDB プロセスのシャットダウン、開始、再起動、または再同期を指示します。エージェントは、Ops Manager との次回のチェックイン時に変更を適用します。プロセスが現在のプライマリである場合、エージェントはまずプロセスを下位に下げて別のメンバーが引き継げるようにし、その後停止または再起動します。

  • 各操作は非同期で行われます。 200 OKという応答は、Ops Manager が変更を公開したことを意味します。プロセスが停止、開始、再起動、または再同期されたことを意味するものではありません。応答にはジョブ ID は含まれません。変更の完了状況を確認するには、自動化ステータスリソースをポーリングしてください。エージェントが変更を適用できない場合、そのリソースではプランが失敗として表示され、エージェントは再試行を続けます。

  • すべてのエンドポイントは、オプションのクエリパラメータdryRun=trueを受け入れます。これを使用して、変更を適用する前にプレビューできます。Ops Manager は同じチェックをすべて実行し、変更後のプロセス ドキュメントを返しますが、エージェントには何も送信せず、デプロイメントも変更しません。たとえば、シャットダウン後に返されるドキュメントには"disabled": trueが含まれます。これを確認してから、 dryRun=trueなしで同じリクエストを送信して変更を適用します。

  • デプロイメントでは、Ops Manager 8.0.28または9.0.2以降のバージョンが実行されている必要があります。

  • プロジェクトに対して自動化が有効になっている必要があり、ターゲットホストの自動化エージェントが実行されている必要があります。

  • プロジェクト内に未公開の自動化構成ドラフトが存在する場合、Ops Manager はドライランを含むすべてのリクエストを拒否します。続行する前に、ドラフトを公開または破棄してください。

  • Project Automation Admin役割を持っている必要があります。

  • これらのエンドポイントは、外部管理プロジェクトやKubernetes Operator(MCK)デプロイメントをサポートしていません。

警告

これらのエンドポイントはクォーラム保護を提供しません。レプリカセットのメンバーを多数シャットダウンすると、プライマリがなくなります。メンバーは1つずつシャットダウンし、それぞれが完全に停止するまで待ってから次の操作に進んでください。

この手順は、実行中のプロセスを正常に停止させます。

1

Ops Manager UI またはv 2.0 Get All Hostsエンドポイントを使用して、プロセスのhostname:portを見つけます。

2
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/process/{HOST-PORT}:shutdown?pretty=true&dryRun=true"
3

リクエストからdryRun=true削除します。Ops Managerは、プロセス文書とともに200 OKを返します。今度は"disabled": trueが含まれています。

4

プロセスのlastGoalVersionAchievedプランのgoalVersionと等しくなるまで、自動化ステータスリソースをポーリングします。

以下の表は、Ops Managerが特定のシナリオにおいてシャットダウン要求をどのように処理するかを示しています。

Scenario
動作

ターゲットは現在の主要な

エージェントは停止させる前に、それを減速させる。

ターゲットは既に閉鎖されています

プロセスに変更はありません。エージェントは何もアクションを起こしませんが、Ops Managerは引き続き構成を公開し、イベントを記録します。

ターゲットは手動モードです

Ops Manager は400でリクエストを拒否しました。手動モードのプロセスを自動化によってシャットダウンすることはできません。

この手順は、以前に停止されたプロセスを開始します。

1

Ops Manager UI またはv 2.0 Get All Hostsエンドポイントを使用して、プロセスのhostname:portを見つけます。

2
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/process/{HOST-PORT}:startup?pretty=true&dryRun=true"
3

リクエストからdryRun=true削除します。Ops Managerは、プロセス文書とともに200 OKを返します。今度は"disabled": falseが含まれています。

4

プランが完了するまで、自動化ステータスリソースをポーリングします。次に、 v 2.0 Get One Host by IDエンドポイント上のメンバーのreplicaStateNameがSECONDARYまたはPRIMARYに戻ることを確認します。

以下の表は、Ops Managerが特定のシナリオで起動要求をどのように処理するかを示しています。

Scenario
動作

ターゲットは既に実行中です

プロセスに変更はありません。エージェントは何もアクションを起こしませんが、Ops Managerは引き続き構成を公開し、イベントを記録します。

プロセスが停止している間にoplogがロールオーバーされました

メンバーはRECOVERING状態から開始され、そのままの状態を維持し、自動的に再同期されません。代わりにプロセスを再同期してください。

この手順は、実行中のプロセスを正常に再起動します。対象が現在のプライマリプロセスである場合、エージェントは再起動する前にプライマリプロセスをダウングレードします。

1

Ops Manager UI またはv 2.0 Get All Hostsエンドポイントを使用して、プロセスのhostname:portを見つけます。

2
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/process/{HOST-PORT}:restart?pretty=true&dryRun=true"
3

リクエストからdryRun=trueを削除します。Ops Managerは、 lastRestartが設定されたプロセス文書とともに200 OKを返します。

4

プランが完了するまで、自動化ステータスリソースをポーリングします。

以下の表は、Ops Managerが特定のシナリオで再起動要求をどのように処理するかを示しています。

Scenario
動作

ターゲットは閉鎖されました

Ops Manager は400 PROCESS_DISABLED_CANNOT_RESTARTでリクエストを拒否しました。代わりにプロセスを開始してください。

ターゲットホストのエージェントは、Ops Managerに報告したことがありません。

Ops Manager は409 PROCESS_AGENT_NOT_REPORTINGでリクエストを拒否しました。

この手順は、レプリカセットメンバーで初期同期をトリガーします。oplogウィンドウに遅れてRECOVERINGの状態から抜け出せなくなったメンバーを復旧するために使用します。

1

Ops Manager UI またはv 2.0 Get All Hostsエンドポイントを使用して、プロセスのhostname:portを見つけます。

2
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/process/{HOST-PORT}:resync?pretty=true&dryRun=true"
3

リクエストからdryRun=trueを削除します。Ops Managerは、 lastResyncが設定されたプロセス文書とともに200 OKを返します。

4

プランが完了するまで、自動化ステータスリソースをポーリングします。次に、 replicaStateNameがSECONDARYになるまで、 v 2.0をポーリングして、ID によるホストを 1 つ取得します。大規模なデータセットの場合、最初の同期には時間がかかる場合があります。

以下の表は、Ops Managerが特定のシナリオで再同期要求をどのように処理するかを示しています。

Scenario
動作

ターゲットはmongos 、スタンドアロン、またはアービターです

Ops Manager は400 PROCESS_RESYNC_NOT_SUPPORTEDでリクエストを拒否しました。データを含むレプリカ セット メンバーのみ再同期できます。

レプリカセットのもう1つのメンバーは既に再同期が未完了となっている。

Ops Manager は、ドライランを含め、リクエストを409 PROCESS_RESYNC_IN_PROGRESSで拒否します。デプロイメントが目標状態に達するまで待ってから、再試行してください。

ターゲットは現在のプライマリー

Ops Manager は200 OKを返しますが、Automation Agent はプライマリを再同期しません。プランはメッセージA resync was requested on a primary. This requires manual interventionとともに保留状態のままになります。メンバーはプライマリとして実行され続けます。

ターゲットホストのエージェントは、Ops Managerに報告したことがありません。

Ops Manager は409 PROCESS_AGENT_NOT_REPORTINGでリクエストを拒否しました。

正常に実行された(ドライランではない)リクエストごとに、通常の自動化構成公開イベントに加えて、プロジェクトのアクティビティフィードにイベントが1つ追加されます。アクティビティフィードは、 APIを使用して行われたリクエストをパブリックAPIに紐付けます。

操作
イベントの種類
これが示すもの

シャットダウン

AUTOMATION_PROCESS_SHUTDOWN_REQUESTED

このプロセスに対してシャットダウン要求が行われました。メンバーが予期せずオフラインになった場合は、このイベントを確認してください。

始める

AUTOMATION_PROCESS_STARTUP_REQUESTED

停止したプロセスを再開するよう要求がありました。

再起動

AUTOMATION_PROCESS_RESTART_REQUESTED

このプロセスに対して再起動要求が行われました。メンバーが一時的に離脱した場合、または選挙が行われた場合は、このイベントを確認してください。

再同期

AUTOMATION_PROCESS_RESYNC_REQUESTED

このプロセスに対して再同期要求が行われました。メンバーがSTARTUP2またはRECOVERINGに入り、データを再コピーしている場合は、このイベントを確認してください。

以下の表は、プロセスライフサイクルエンドポイントを使用する際に発生する一般的なエラーと症状について説明しています。

シンボリック
考えられる原因
解決法

409 AUTOMATION_CONFIG_DRAFT_ALREADY_EXISTS

プロジェクト内に、未公開の自動化設定ドラフトが存在します。

下書きを公開するか破棄するかを選択し、再度試してください。

409 AUTOMATION_CONFIG_CONCURRENT_MODIFICATION

誰かが、Ops Managerが設定を読み込む際と公開する際の間に変更を加えたことを公開しました。

リクエストを再試行してください。

409 GROUP_IN_RESTORATION_MODE

プロジェクトは復旧後、調整段階に入っています。

調整処理が完了するまで待ってから、再度お試しください。

409 PROCESS_AGENT_NOT_REPORTING

対象ホストのエージェントは、Ops Managerに報告したことがありません。

エージェントがインストールされ、実行中で、Ops Managerにアクセスできることを確認してから、再試行してください。

403 PROCESS_EXTERNALLY_MANAGED

プロジェクトのプロセスは外部システムによって管理されています。

これらのエンドポイントは、外部管理プロジェクトには適用されません。

404 PROCESS_NOT_FOUND

hostname:port プロジェクトの自動化設定にあるプロセスと一致しません。

v 2.0 Get All Hostsで値を確認してから、再試行してください。

400 PROCESS_DISABLED_CANNOT_RESTART

処理は停止されました。

代わりに起動エンドポイントを呼び出してください。

409 PROCESS_RESYNC_IN_PROGRESS

このレプリカセットの再同期は既に要求されており、デプロイメントはまだ目標状態に達していません。プライマリで要求された再同期など、処理が停止している再同期は、新しい要求をブロックし続けます。

プランが完了するまで自動化ステータスリソースをポーリングし、その後再試行します。

400 PROCESS_RESYNC_NOT_SUPPORTED

対象はmongos 、スタンドアロン、またはアービターであり、同期するデータはありません。

代わりに、データを含むレプリカセットメンバーを再同期してください。

400 INVALID_QUERY_PARAMETER

dryRun trueやfalseは空の値を含めて除外されます。たとえば、 dryRun=truやdryRun=などです。

値を変更するか、パラメータを省略してください。

再同期後、自動化ステータスに手動介入が必要と表示されます。

プライマリサーバーで再同期が要求されました。

プライマリをダウングレードして、再同期のブロックを解除します。

自動化ステータスで計画が失敗し続けています

エージェントは変更を適用できません。たとえば、ホストにアクセスできない場合などが考えられます。

自動化ステータス応答でプロセスのエラーを確認し、原因を修正してください。その後、エージェントは再試行します。

メンバーは起動後もRECOVERINGに留まります

プロセスが停止している間にoplogがローテーションしてしまったため、メンバーは追いつくことができませんでした。

プロセスを再同期し、ホスト上のreplicaStateName SECONDARYになるまでチェックします。