Docs Home

/ /

再選挙ジョブ

Docs Home

/ /

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

注意

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

このエンドポイントを使用して、特定のレプリカセットのすべての再選挙ジョブを取得します。

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

Resource

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

必須のロール

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

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

名前	タイプ	必要性	説明
グループ ID	string	必須	プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。
RS- ID	string	必須	再選挙ジョブを一覧表示するレプリカセットの名前。

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

名前	タイプ	説明	default
pageNum	integer	ページ番号（1 インデックスベース）。	`1`
itemsPerPage	integer	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	レスポンス本体を pretty-print 形式にするかどうかを示します。	`false`
envelope	ブール値	応答をエンベロープでラップするかどうかを示します。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで `"envelope" : true` を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTPレスポンスコード `content`: 期待される応答本体結果のリストを返すエンドポイントの場合、 `results`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	なし

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

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

応答

応答には、再選挙されたジョブオブジェクトの配列と、検索されたジョブオブジェクトの合計数が含まれます。

名前	タイプ	説明
結果	配列	最近作成されたジョブから最も最近の作成がない順にソートされた再選挙ジョブの配列。 `results`埋め込みドキュメントを参照してください。
totalCount	数値	結果セット内の項目の合計数。応答がページ分割されると、これは `results` のアイテム数を超える可能性があります。

`results` embeddedDocument

results の各要素は 1 つの再選出ジョブを表します。

名前	タイプ	説明
id	string	再選択ジョブを識別する一意の 24 桁の 16 進数文字列。
グループ 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形式）。
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      --include \
4      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs?pretty=true"

応答例

応答ヘッダー

HTTP/1.1 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

HTTP/1.1 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   "results": [
3     {
4       "id": "665a1234567890abcdef5678",
5       "groupId": "5c8100bcf2a30b12ff88258f",
6       "action": "STEP_UP",
7       "replicaSetName": "rs0",
8       "hostname": "node2.example.com",
9       "port": 27017,
10       "status": "COMPLETED",
11       "noOp": false,
12       "message": null,
13       "created": "2026-08-11T05:40:00Z",
14       "lastUpdated": "2026-08-11T05:41:15Z",
15       "expires": "2026-08-11T05:45:00Z"
16     },
17     {
18       "id": "665a1234567890abcdef1234",
19       "groupId": "5c8100bcf2a30b12ff88258f",
20       "action": "STEP_DOWN",
21       "replicaSetName": "rs0",
22       "hostname": "node1.example.com",
23       "port": 27017,
24       "status": "COMPLETED",
25       "noOp": false,
26       "message": null,
27       "created": "2026-08-11T05:37:59Z",
28       "lastUpdated": "2026-08-11T05:38:30Z",
29       "expires": "2026-08-11T05:42:59Z"
30     }
31   ],
32   "totalCount": 2
33 }

応答コード

HTTP Status	エラーコード	説明
200	--	再選択ジョブの配列を返します。
401	USER_UNAUTHORIZED	APIキーに `Project Automation Admin` ロールがありません。

戻る

1 つの取得

エージェント

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?pretty=true"

1	{
2	"results": [
3	{
4	"id": "665a1234567890abcdef5678",
5	"groupId": "5c8100bcf2a30b12ff88258f",
6	"action": "STEP_UP",
7	"replicaSetName": "rs0",
8	"hostname": "node2.example.com",
9	"port": 27017,
10	"status": "COMPLETED",
11	"noOp": false,
12	"message": null,
13	"created": "2026-08-11T05:40:00Z",
14	"lastUpdated": "2026-08-11T05:41:15Z",
15	"expires": "2026-08-11T05:45:00Z"
16	},
17	{
18	"id": "665a1234567890abcdef1234",
19	"groupId": "5c8100bcf2a30b12ff88258f",
20	"action": "STEP_DOWN",
21	"replicaSetName": "rs0",
22	"hostname": "node1.example.com",
23	"port": 27017,
24	"status": "COMPLETED",
25	"noOp": false,
26	"message": null,
27	"created": "2026-08-11T05:37:59Z",
28	"lastUpdated": "2026-08-11T05:38:30Z",
29	"expires": "2026-08-11T05:42:59Z"
30	}
31	],
32	"totalCount": 2
33	}

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

Resource

必須のロール

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

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

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

応答

results embeddedDocument

リクエストの例

応答例

応答ヘッダー

レスポンス本体

応答コード

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

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

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

`results` embeddedDocument