すべてのアクティブな Ops Manager サーバーの一覧を返します。 MongoDB Ops Manager は、過去 20 秒以内にアプリケーション データベースにハートビートを送信した場合、サーバーがアクティブであると見なします。このエンドポイントを使用して、ログコレクションリクエストを送信する前に、有効な serverId 値を見つけます。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/servers
必須のロール
このエンドポイントを呼び出す APIキーに Global Read Onlyロールが必要です。
Request Parameters
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
| 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
| 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
| string | 任意 | フィルタリングするサーバーの種類。複数のタイプを含めるには、このパラメーターを複数回渡します（ | すべてのタイプ |
| string | 任意 | フィルタリングするサーバーステータス。現在有効な値は |
|
| ブール値 | 任意 | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 |
|
| ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
レスポンスには、サーバーオブジェクトの配列、リンク オブジェクトの配列、および検索されたサーバーオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | アクティブな Ops Manager サーバーの配列。結果の 埋め込みドキュメント を参照してください。 |
| 配列 | サブリソースまたは関連リソースへの 1 つ以上のリンクの配列。 URL 間の関係は、Web リンク仕様に従います（RFC5988 ）。 |
| 数値 | 結果セット内の項目の合計数。ページ分割すると、 |
結果 埋め込みドキュメント
各 results 要素は 1 つのアクティブな Ops Managerサーバーを表します。
名前 | タイプ | 説明 |
|---|---|---|
| string | アクティブな Ops Managerサーバーの識別子。 |
| string | サーバーのタイプ 。現在は常に |
| string | サーバーが最後にハートビートを送信したときのタイムスタンプ（ISO 8601 UTC形式 ） 。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/servers?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}
レスポンス本体
{ "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/servers?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "serverId": "om-server-1.example.com", "serverType": "MMS_SERVER", "lastPing": "2026-04-13T10:00:15Z" }, { "serverId": "om-server-2.example.com", "serverType": "MMS_SERVER", "lastPing": "2026-04-13T10:00:12Z" } ], "totalCount": 2 }