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

1つのレプリカセット再選挙ジョブを取得する

注意

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

このエンドポイントとなる接続されたデバイスを使用して、一意の識別子によって単一の再選挙ジョブを検索します。ジョブがターミナルステータスに達するまで、このエンドポイントとなる接続されたデバイスをポーリングします。

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

GET /groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}

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

名前
タイプ
必要性
説明

グループ ID

string

必須

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

RS-ID

string

必須

再選挙ジョブを含むレプリカセットの名前。

再選ジョブID

string

必須

step down または step up エンドポイントとなる接続されたデバイスによって返される再選挙ジョブを識別するユニークな 24 桁の 16 進数文字列。

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

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

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

false

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

レスポンスは、単一の再選挙ジョブを返します。

名前
タイプ
説明

id

string

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

グループ ID

string

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

アクション

string

このジョブが実行するアクション。STEP_DOWN または 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形式 ) 。

最終更新日時

string

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

expires

string

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

ステータス
ターミナル
意味

キュー済み

No

MongoDB Ops Managerがジョブを作成しました。ターゲットホストのオートメーションエージェントがジョブを取得するのを待機しています。

実行中

No

エージェントがジョブを実行しています。

completed

はい

操作が完了しました。`noOp` を確認して、操作によって変更が行われたかどうかを判定してください。

失敗

はい

操作を完了できませんでした。理由については、messageを参照してください。

期限切れ

はい

expiresAfterSeconds が経過する前にジョブを取得したエージェントはありませんでした。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}?pretty=true"
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-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_UP", "replicaSetName": "rs0", "hostname": "node2.example.com", "port": 27017, "status": "COMPLETED", "noOp": false, "message": null, "created": "2026-08-11T05:37:59Z", "lastUpdated": "2026-08-11T05:38:45Z", "expires": "2026-08-11T05:39:59Z"}
HTTP Status
エラー コード
説明

200

--

再選挙ジョブドキュメントを返します。

401

USER_UNAUTHORIZED

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

404

REELECTION_JOB_NOT_FOUND

REELECTION-JOB-ID は不明か形式が正しくないか、またはジョブがRS-IDで指定されたレプリカセットに属していません。