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

レプリカセットのプライマリのステップダウンをリクエストする

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。

このエンドポイントとなる接続されたデバイスを使用して、レプリカセットの現在のプライマリがステップダウンし、新しい選挙をトリガーします。MongoDB Ops Manager は、ターゲットホストのオートメーションエージェントが次回のチェックイン時に実行するバックグラウンドジョブをキューに入れます。

エージェントがジョブを実行するとき、ターゲット プロセスが書き込み可能なプライマリでない場合、ジョブは失敗するのではなく、ノーオペレーションとして完了します。プライマリが降格した後、stepDownSecs で指定された期間、再選挙の対象外となります。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /groups/{GROUP-ID}/replicaSets/{RS-ID}/process/{HOST-PORT}:stepDown

このリクエストを行うAPIキーには、Project Automation Adminロールが必要です。

名前
タイプ
必要性
説明

グループ ID

string

必須

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

RS-ID

string

必須

ターゲットプロセスを含むレプリカセットの名前。

ホストする-ポート

string

必須

hostname:port としてのターゲットプロセス。このプロセスは、現在レプリカセットのプライマリである必要があります。

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体をpretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

リクエストボディでは、以下の任意の調整項目を指定できます。空のボディを送信する場合は、{}を使用してください。

名前
タイプ
説明
default

stepDownSecs

integer

ステップダウンしたプライマリが再選挙の対象外となる秒数。0 より大きくする必要があります。

60

secondaryCatchUpPeriodSecs

integer

プライマリがステップダウンする前に、遅延しているセカンダリが追いつくのを待機する秒数。0 以上である必要があります。このフィールドを省略した場合、mongod は独自のデフォルトを適用します。

なし

expiresAfterSeconds

integer

ジョブが期限切れになる前に、オートメーションエージェントがリクエストをピックアップするためにキューに留まる秒数。0 より大きくする必要があります。

300

Ops Managerは、1つの再選挙ジョブを取得エンドポイントとなる接続されたデバイスを指す点であるLocationヘッダーを含む202 Acceptedを返し、レスポンス本文には再選挙ジョブドキュメントを返します。

名前
タイプ
説明

id

string

再選挙ジョブを識別するユニークな 24 桁の 16 進数の string。

グループ ID

string

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

アクション

string

このジョブが実行するアクション。STEP_DOWN を返します。

ReplicaSetName

string

ターゲットレプリカセットの名前。

Hostname

string

ターゲットプロセスのホスト名。

ポート

integer

ターゲットプロセスのポート。

状態

string

ジョブのステータス。QUEUED、RUNNING、COMPLETED、FAILED、または EXPIRED のいずれかの値を返します。

noop

ブール値

操作がノーオペレーションとして完了したかどうかを示すフラグ。エージェントがジョブを実行したときにターゲットプロセスがすでにセカンダリであった場合は、trueを返します。

メッセージ

string

ジョブに関する人間が読める形式の詳細。エージェントが結果を報告した後、MongoDB Ops Managerがこのフィールドに値を入力します。

作成済み

string

Ops Manager がジョブを作成したときのタイムスタンプ(ISO 8601 UTC形式 ) 。

最終更新日時

string

MongoDB Ops Managerが最後にジョブを更新した日時(ISO 8601 UTC形式)。

expires

string

オートメーションエージェントがこのジョブをこれ以上取得しなくなるISO 8601 UTC形式のタイムスタンプ。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/process/{HOST-PORT}:stepDown?pretty=true" \ --data '{ "stepDownSecs": 60, "secondaryCatchUpPeriodSecs": 10 }'
HTTP/1.1 202 AcceptedVary: Accept-EncodingContent-Type: application/jsonLocation: https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}Strict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "id": "665a1234567890abcdef1234", "groupId": "5c8100bcf2a30b12ff88258f", "action": "STEP_DOWN", "replicaSetName": "rs0", "hostname": "node1.example.com", "port": 27017, "status": "QUEUED", "noOp": false, "message": null, "created": "2026-08-11T05:37:59Z", "lastUpdated": "2026-08-11T05:37:59Z", "expires": "2026-08-11T05:42:59Z"}
HTTP Status
エラー コード
説明

202

--

リクエストを受け付けました。再選挙ジョブのドキュメントを返します。

400

INVALID_PARAMETER

チューナブルが範囲外であるか、リクエスト本文に freezeSecs が含まれています。

400

AUTOMATION_AGENT_VERSION_NOT_SUPPORTED

ターゲットホストのオートメーションエージェントが 109.0.0.9226-1 より古いです。

401

USER_UNAUTHORIZED

APIキーにはProject Automation Adminロールがありません。

401

ユーザーは組織にアクセスできません

呼び出し元はプロジェクトの組織外にあります。

404

自動化構成が見つかりません

プロジェクトには公開されたオートメーション構成がありません。

404

CLUSTER_NOT_FOUND

RS-ID プロジェクトの配置内のレプリカセットと一致しません。

404

PROCESS_NOT_IN_CLUSTER

HOST-PORT は、指定されたレプリカセットのノードではありません。

409

REELECTION_AGENT_NOT_RESPONDING

ターゲットホストのオートメーションエージェントが、最近MongoDB Ops Managerにpingを送信していません。

409

REELECTION_ALREADY_IN_PROGRESS

このレプリカセットでは、再選挙ジョブがすでにキューに入れられているか、実行中です。