注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
このエンドポイントを使用して、一意の識別子で 1 つの再選挙ジョブを検索します。ジョブがターミナルステータスに達するまで、このエンドポイントをポーリングします。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}
必須のロール
このリクエストを行うAPIキーには Project Automation Admin ロールが必要です。
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
グループ ID | string | 必須 | プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。 |
RS- ID | string | 必須 | 再選択ジョブを含むレプリカセットの名前。 |
REELECTION-JOB- ID | string | 必須 | ステップダウンまたはステップアップ エンドポイントによって返される、 再選挙ジョブ を識別する一意の 24 桁の 16 進数文字列。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
レスポンスは 1 つの 再選挙ジョブを返します。
名前 | タイプ | 説明 |
|---|---|---|
id | string | 再選択ジョブを識別する一意の 24 桁の 16 進数文字列。 |
グループ ID | string | プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。 |
アクション | string | このジョブが実行するアクション。次のいずれかの値を返します: |
ReplicaSetName | string | ターゲットレプリカセットの名前。 |
Hostname | string | ターゲット プロセスのホスト名。 |
ポート | integer | ターゲット プロセスのポート。 |
状態 | string | ジョブのステータス。次のいずれかの値を返します: |
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形式 ）で、オートメーションエージェントがこのジョブを選択しなくなります。 |
ジョブ ステータス値
ステータス | ターミナル | 意味 |
|---|---|---|
QUEUED | No | MongoDB Ops Manager はジョブを作成しました。ターゲット ホストのオートメーションエージェントがそれを選択するのを待っています。 |
実行しています。 | No | エージェントはジョブを実行中。 |
完了済み | はい | 操作が終了しました。操作によって変更が行われたかどうかを判断するには、 |
失敗 | はい | 操作を完了できませんでした。理由については、 |
EXPILED | はい |
|
リクエストの例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}?pretty=true"
応答例
応答ヘッダー
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json 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": "COMPLETED", 9 "noOp": false, 10 "message": null, 11 "created": "2026-08-11T05:37:59Z", 12 "lastUpdated": "2026-08-11T05:38:45Z", 13 "expires": "2026-08-11T05:39:59Z" 14 }
応答コード
HTTP Status | エラー コード | 説明 |
|---|---|---|
200 | -- | 再選択ジョブドキュメントを返します。 |
401 | USER_UNAUTHORIZED | APIキーに |
404 | REELECTION_JOB_NOT_FOUND |
|