Docs Home

/ /

再選挙ジョブ

Docs Home

/ /

レプリカセットのセカンダリステップアップの要求

注意

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

このエンドポイントを使用して、レプリカセットの特定のセカンダリがプライマリになるようリクエストます。 Ops Manager は、他のノードではなくターゲットプロセスが選挙で選出されるように、他の選挙可能なセカンダリをフリーズします。ターゲットホストのオートメーションエージェントは、次回のチェックインでフリーズとステップダウンの手順を実行します。

エージェントがジョブを実行するときに、ターゲットプロセスが選択可能なセカンダリではない場合（例、そのプロセスがすでにプライマリであるか、アービタ、非表示、または投票権のないノードであるため）、ジョブは失敗し、わかりやすいメッセージが表示されます。

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

Resource

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

必須のロール

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

リクエストパスパラメーター

名前	タイプ	必要性	説明
グループ ID	string	必須	プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。
RS- ID	string	必須	ターゲットプロセスを含むレプリカセットの名前。
HOST-port	string	必須	ターゲットプロセス。`hostname:port` として。このプロセスは現在アクティブで、選択可能なセカンダリである必要があります。

リクエストクエリパラメータ

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

名前	タイプ	必要性	説明	default
pretty	ブール値	任意	レスポンス本体をpretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTPレスポンスコード `content`: 期待される応答本体	`false`

リクエストボディパラメータ

リクエスト本文では、次の任意の調整可能値を受け入れます。空のボディを送信する場合は {} を使用します。

名前	タイプ	説明	default
stepDownSecs	integer	送信プライマリが再選挙の資格がない状態である秒数。 `0` より大きくする必要があります。	`60`
secondaryCatchUpPeridSecs	integer	プライマリが降格する前に、遅延しているセカンダリが追いつくまで待機する秒数。 `0` 以上である必要があります。このフィールドを省略すると、`mongod` は独自のデフォルトのを適用します。	なし
preserveSecs	integer	ターゲットが選挙で選出されるよう、MongoDB Ops Manager が他の選挙可能なセカンダリをフリーズする秒数。 `0` 以上かつ `stepDownSecs` 以上である必要があります。	`120` と `stepDownSecs` のうち大きい方
expiresAfterSeconds	integer	ジョブが期限切れになる前にオートメーションエージェントが取得するまでリクエストがキューに入れられたままの秒数。 `0` より大きくする必要があります。	`300` と `freezeSecs` のうち大きい方

重要

フリーズウィンドウ中は、他のすべての選択可能なセカンダリは固定され、選挙で待機できなくなります。環境に応じて、freezeSecs を短くします。フリーズ中にターゲットホストにアクセスできなくなった場合、レプリカセットはフリーズが終了するまでプライマリなしで残すことができます。

応答

MongoDB Ops Manager202 Accepted は、1Location つの再選挙ジョブエンドポイントを取得するためのヘッダーと、レスポンス本文に再選挙ジョブドキュメントを含むを返します。

名前	タイプ	説明
id	string	再選択ジョブを識別する一意の 24 桁の 16 進数文字列。
グループ ID	string	プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。
アクション	string	このジョブが実行するアクション。 `STEP_UP` を返します。
ReplicaSetName	string	ターゲットレプリカセットの名前。
Hostname	string	ターゲットプロセスのホスト名。
ポート	integer	ターゲットプロセスのポート。
状態	string	ジョブのステータス。次のいずれかの値を返します: `QUEUED`、`RUNNING`、`COMPLETED`、`FAILED`、または `EXPIRED`
noOp	ブール値	操作がno-op として完了したかどうかを示すフラグ。
メッセージ	string	ジョブに関する人間が判読可能な詳細。 MongoDB Ops Manager は、エージェントが結果を報告した後にこのフィールドに入力します。
作成済み	string	Ops Manager がジョブを作成したときのタイムスタンプ（ISO 8601 UTC形式）。
lastUpdated	string	Ops Manager がジョブを最後にアップデートしたときのタイムスタンプ（ISO 8601 UTC形式）。
expires	string	タイムスタンプ（ ISO 8601 UTC形式）で、オートメーションエージェントがこのジョブを選択しなくなります。

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/process/{HOST-PORT}:stepUp?pretty=true" \
6      --data '{
7        "stepDownSecs": 60,
8        "freezeSecs": 120
9      }'

応答例

応答ヘッダー

HTTP/1.1 202 Accepted
Vary: Accept-Encoding
Content-Type: application/json
Location: https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

1 {
2   "id": "665a1234567890abcdef1234",
3   "groupId": "5c8100bcf2a30b12ff88258f",
4   "action": "STEP_UP",
5   "replicaSetName": "rs0",
6   "hostname": "node2.example.com",
7   "port": 27017,
8   "status": "QUEUED",
9   "noOp": false,
10   "message": null,
11   "created": "2026-08-11T05:37:59Z",
12   "lastUpdated": "2026-08-11T05:37:59Z",
13   "expires": "2026-08-11T05:39:59Z"
14 }

応答コード

HTTP Status	エラーコード	説明
202	--	リクエストを受け付けました。再選択ジョブドキュメントを返します。
400	INVALID_PARAMETER	調整可能なが範囲外であるか、`freezeSecs` は `stepDownSecs` より小さいです。
400	Automation_ Agent_VERSION_NOT_SUPportED	ターゲットホストのオートメーションエージェントは `109.0.0.9226-1` より古いです。
401	USER_UNAUTHORIZED	APIキーに `Project Automation Admin` ロールがありません。
401	USER_CANNOT_ACCESS_ORG	呼び出し元はプロジェクトの組織の外部にあります。
404	Automation_CONconfig_NOT_FOUND	プロジェクトに公開されたオートメーション構成はありません。
404	CLUSTER_NOT_FOUND	`RS-ID` は、プロジェクトの配置内のレプリカセットと一致しません。
404	PROCESS_NOT_IN_CLUSTER	`HOST-PORT` は、という名前のレプリカセットのメンバーではありません。
409	REELECTION_Agent_NOT_RESPODING	ターゲットホストのオートメーションエージェントは最近 MongoDB Ops Manager を ping しません。
409	REELECTION_ALREABY_IN_PROGESS	このレプリカセットに対して再選択ジョブはすでにキューに入れられているか、実行中です。

戻る

プライマリの降格

1 つの取得

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/process/{HOST-PORT}:stepUp?pretty=true" \
6	--data '{
7	"stepDownSecs": 60,
8	"freezeSecs": 120
9	}'

1	{
2	"id": "665a1234567890abcdef1234",
3	"groupId": "5c8100bcf2a30b12ff88258f",
4	"action": "STEP_UP",
5	"replicaSetName": "rs0",
6	"hostname": "node2.example.com",
7	"port": 27017,
8	"status": "QUEUED",
9	"noOp": false,
10	"message": null,
11	"created": "2026-08-11T05:37:59Z",
12	"lastUpdated": "2026-08-11T05:37:59Z",
13	"expires": "2026-08-11T05:39:59Z"
14	}

レプリカセットのセカンダリ ステップアップの要求

Resource

必須のロール

リクエスト パス パラメーター

リクエスト クエリ パラメータ

リクエスト ボディ パラメータ

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

応答コード

レプリカセットのセカンダリステップアップの要求

リクエストパスパラメーター

リクエストクエリパラメータ

リクエストボディパラメータ