Ops Manager API を使用すると、MongoDB プロセスのシャットダウン、起動、再起動、および再同期を実行できます。各リクエストは自動化構成内のプロセスを更新し、変更を即座に公開します。ターゲットホストの Automation Agent は、次回のチェックイン時に変更を適用します。プロセスが現在のプライマリである場合、エージェントはまずプロセスを下位に下げて別のメンバーが引き継げるようにし、その後停止または再起動します。
各操作は非同期で行われます。 200 OKという応答は、Ops Manager が変更を公開したことを意味します。プロセスが停止、開始、再起動、または再同期されたことを意味するものではありません。応答にはジョブ ID は含まれません。変更の完了状況を確認するには、自動化ステータスリソースをポーリングしてください。エージェントが変更を適用できない場合、そのリソースではプランが失敗として表示され、エージェントは再試行を続けます。
すべてのエンドポイントは、オプションのクエリパラメータdryRun=trueを受け入れます。これを使用して、変更を適用する前にプレビューできます。Ops Manager は同じチェックをすべて実行し、変更後のプロセス ドキュメントを返しますが、エージェントには何も送信せず、デプロイメントも変更しません。たとえば、シャットダウン後に返されるドキュメントには"disabled": trueが含まれます。これを確認してから、 dryRun=trueなしで同じリクエストを送信して変更を適用します。
前提条件
プロセスライフサイクルリソースを使用する前に、以下の要件を確認してください。
注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
プロセスライフサイクルリソースを使用するには、 Project Automation Adminロールを持つOps Managerユーザーである必要があります。
デプロイメントでは、Ops Manager 8.0.28または9.0.2以降のバージョンが実行されている必要があります。プロジェクトで自動化が有効になっている必要があり、ターゲットホストの自動化エージェントが実行されている必要があります。
プロジェクトに未公開の自動化構成ドラフトが存在する場合、Ops Manager はドライランを含むすべてのリクエストをエラー409 AUTOMATION_CONFIG_DRAFT_ALREADY_EXISTSで拒否します。続行する前に、ドラフトを公開または破棄してください。
すべての検証はドライランにも適用されるため、ドライランが成功すれば、実際の要求も同じチェックを通過すると予測されます。ただし、同時変更や手動モード検証では、実際の要求が失敗する可能性があります。
重要
プロセスライフサイクル操作は、外部管理プロジェクトまたはKubernetes Operator(MCK)デプロイメントではサポートされていません。
警告
これらのエンドポイントはクォーラム保護を提供しません。レプリカセットのメンバーを多数シャットダウンすると、プライマリがなくなります。メンバーは1つずつシャットダウンし、それぞれが完全に停止するまで待ってから次の操作に進んでください。
エンドポイント
以下の表は、プロセスライフサイクルリソースで使用可能なエンドポイントの一覧です。
方式 | エンドポイント | 説明 |
|---|---|---|
| 実行中のプロセスを正常に停止します。 | |
| 以前に停止されたプロセスを開始します。 | |
| 実行中のプロセスを正常に再起動します。 | |
| レプリカセットメンバーで初期同期をトリガーします。 |
監査証跡
ドライランではない、正常に完了したリクエストごとに、通常の自動化構成の公開イベントに加えて、プロジェクトのアクティビティフィードにイベントが1つ追加されます。アクティビティフィードは、 APIを使用して行われたリクエストをパブリックAPIに紐付けます。
操作 | イベントの種類 | これが示すもの |
|---|---|---|
| このプロセスに対してシャットダウン要求が行われました。メンバーが予期せずオフラインになった場合は、このイベントを確認してください。 | |
| 停止したプロセスを再開するよう要求がありました。 | |
| このプロセスに対して再起動要求が行われました。メンバーが一時的に離脱した場合、または選挙が行われた場合は、このイベントを確認してください。 | |
| このプロセスに対して再同期要求が行われました。メンバーが |