1 つのプロジェクトのすべてのホストを取得

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
応答ドキュメント
results embeddedDocument
リクエストの例
応答例
応答ヘッダー
レスポンス本体

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

注意

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

プロジェクト内のすべての MongoDB ホストを取得します。指定されたクラスターに属するホストのみを取得するには、 CLUSTER-IDクエリパラメーターを使用します。レスポンスは、ホストをホスト名: ポートでアルファベット順にソートします。

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

Resource

GET /groups/{PROJECT-ID}/hosts

GET /groups/{PROJECT-ID}/hosts?clusterId={CLUSTER-ID}

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

Parameter	タイプ	必要性	説明
プロジェクトID	string	必須	この MongoDB ホストを所有するプロジェクトの一意の識別子。

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

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope : true`を設定します。結果のリストを返すエンドポイントの場合、 `results`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`
backupJobsEnabledOnly	ブール値	任意	データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。これを`false`に設定し、 `backupJobsEnabled`フラグが`false`に設定されているデーモン構成を含めます。	`true`

Parameter	タイプ	必要性	説明
CLUSTER-ID	string	必須	この MongoDB プロセスが属するクラスターのユニーク識別子。

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

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

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、 `results`埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つのホストです。

名前	タイプ	説明
aliases	文字列の配列	MongoDB プロセスのために MongoDB Ops Manager が検出したホスト名とポートの代替組み合わせの配列。これらの組み合わせには、ホスト名、 FQDN 、 IPv4アドレス、およびIPv6アドレスが含まれます。
alertsEnabled	ブール値	`true` この MongoDB プロセスでアラートが有効になっている場合
authMechanismName	string	この MongoDB プロセスに接続するために使用される認証メカニズム。これには、次のいずれかの値のみが表示されます。 `MONGODB_CR` （これは SCRAM-SHA-1、SCRAM-SHA-256、MONGODB-CR をカバーします。） `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
clusterId	string	MongoDB プロセスが属するクラスターのユニーク識別子です。
作成済み	date	MongoDB Ops Manager がこの MongoDB プロセスを作成または最初に検出した日付。
グループ ID	string	このホストを所有するグループの一意の識別子。
hasStartupServings	ブール値	`true` この MongoDB プロセスに起動時の警告があった場合、。
hidden	ブール値	`true` ホストが MongoDB Ops Manager UI に表示されている場合。 `true`に設定されたホストはAPI応答から省略されます。
hiddenSecondary	ブール値	`true` このホストが非表示のセカンダリである場合。
hostEnabled	ブール値	`true` MongoDB プロセスが現在有効になっている場合。
Hostname	string	MongoDB Ops Manager が決定できるプライマリホスト名。これは、ホスト名、 FQDN 、 IPv4アドレス、またはIPv6アドレスにすることができます。
id	string	Unique identifier.
ipAddress	string	この MongoDB プロセスの`hostname`に関連付けられているIPv4アドレスまたはIPv6アドレス。追加のアクセス可能なIPv4またはIPv6アドレスは`aliases`配列に表示される場合があります。
journalingEnabled	ブール値	`true` この MongoDB プロセスでジャーナリングが有効になっている場合は。
lastDataSizeBytes	数値	ディスク上のホストのデータベースの非圧縮サイズ（インデックスを除く）。 `lastDataSizeBytes`にはローカルデータベース内のデータは含まれません。
lastIndexSizeBytes	数値	ディスク上のホストのデータベースインデックスの非圧縮サイズ（バイト単位）。この数にはローカルデータベースのインデックスのサイズは含まれません。
lastPing	date	ISO8601 のタイムスタンプこの MongoDB プロセスの最後の ping が受信されたとき、 UTC で表された日付と時刻形式。
lastRestart	date	ISO8601 のタイムスタンプこのプロセスが最後に再起動されたときの日付と時刻形式（ UTC）。MongoDB プロセスが再起動されていない場合、 `lastRestart`フィールドは省略されます。
Links	配列	サブリソースや関連リソースへの 1 つ以上のリンクを含む配列。 URL の関係は、 Web リンク仕様で説明されています。少なくとも、 `links`配列には`self`と呼ばれる 1 つのリンクが含まれています。
logsEnabled	ブール値	`true` MongoDB Ops Manager がこの MongoDB プロセスのログを収集している場合は、。
slowUlimit	ブール値	`true` この MongoDB プロセスのホストの`ulimit`設定が低い場合。
ポート	数値	MongoDB プロセスが listen するポート。
profileEnabled	ブール値	`true` MongoDB Ops ManagerがこのMongoDBプロセスからプロファイル情報を収集する場合。
ReplicaSetName	string	このプロセスが属するレプリカセットの名前。このプロセスがレプリカセットの一部である場合にのみ存在します。
replicaStateName	string	レプリカセット内のこの MongoDB プロセスの現在の状態。このプロセスがレプリカセットの一部である場合にのみ存在します。可能な値については、「レプリカセットノードの状態」を参照してください。
shardName	string	このプロセスが属するシャードの名前。プロセスがシャーディングされたクラスターの一部である場合にのみ存在します。
secondaryDelaySecs	数値	このレプリカセットメンバーのデータがプライマリより続く秒数。この値が`0`に設定されている場合、ノードは遅延ノードとして構成されません。セカンダリ遅延の詳細については、「遅延レプリカセットノード」を参照してください
sslEnabled	ブール値	`true` この MongoDB プロセスでTLS / SSLおよびが有効になっている場合。
systemInfo	オブジェクト	オペレーティングシステムまたはコンテナによって報告される、この MongoDB プロセスのサーバーの RAM および CPU 情報を含むオブジェクト。
systemInfo.memSizeMB	数値	RAM の量（メガバイト単位）。
systemInfo.numCores	数値	CPU コアの数。
typeName	string	この MongoDB プロセスのタイプ。可能な値は次のとおりです。 `STANDALONE` `REPLICA_PRIMARY` `REPLICA_SECONDARY` `REPLICA_ARBITER` `RECOVERING` `SHARD_MONGOS` `SHARD_CONFIG` `SHARD_STANDALONE` `SHARD_PRIMARY` `SHARD_SECONDARY` `NO_DATA` MongoDB Ops Manager に追加された新しいホストのタイプは、モニタリングが最初の ping を受信するまで`NO_DATA`になります。
uptimeMsec	数値	このプロセスが最後に再起動されてからのミリ秒数。
バージョン	string	このプロセスで実行されている MongoDB のバージョン。

注意

一部のホストはclusterIdを返しません。これは、 mongosプロセスがデータを保存していないシャードにデータ操作をルーティングする場合に発生します。 MongoDB Ops Manager では、データを保持しない一部のノードにはclusterIdは割り当てられません。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts?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   "totalCount" : 2,
3   "results" : [
4     {
5       "alertsEnabled" : true,
6       "aliases": [ "{HOSTNAME}:26000", "{IP-ADDRESS}:26000" ],
7       "authMechanismName" : "SCRAM-SHA-1",
8       "clusterId" : "{CLUSTER-ID}",
9       "created" : "2014-04-22T19:56:50Z",
10       "groupId" : "{PROJECT-ID}",
11       "hasStartupWarnings" : false,
12       "hidden" : false,
13       "hostEnabled" : true,
14       "hostname" : "{HOSTNAME}",
15       "id" : "{HOST-ID}",
16       "ipAddress": "127.0.0.1",
17       "journalingEnabled" : false,
18       "lastDataSizeBytes" : 633208918,
19       "lastIndexSizeBytes" : 101420524,
20       "lastPing" : "2016-08-18T11:23:41Z",
21       "links" : [  ],
22       "logsEnabled" : false,
23       "lowUlimit" : false,
24       "muninEnabled" : false,
25       "port" : 26000,
26       "profilerEnabled" : false,
27       "replicaSetName": "rs1",
28       "replicaStateName" : "PRIMARY",
29       "sslEnabled" : true,
30       "systemInfo" : {
31         "memSizeMB" : 65536,
32         "numCores" : 16
33       },
34       "typeName": "REPLICA_PRIMARY",
35       "uptimeMsec": 1827300394,
36       "username" : "mongo",
37       "version" : "4.0.0"
38     },
39     {
40 
41     }
42   ]
43 }

注意

MongoDB Ops Managerは応答で MongoDB Ops Manager を返しますが、 MongoDB Ops Manager はは、MongoDB Ops Manager4 . 以降、サポートされていません。4

戻る

ホスト

ID でホストを取得

1	{
2	"totalCount" : 2,
3	"results" : [
4	{
5	"alertsEnabled" : true,
6	"aliases": [ "{HOSTNAME}:26000", "{IP-ADDRESS}:26000" ],
7	"authMechanismName" : "SCRAM-SHA-1",
8	"clusterId" : "{CLUSTER-ID}",
9	"created" : "2014-04-22T19:56:50Z",
10	"groupId" : "{PROJECT-ID}",
11	"hasStartupWarnings" : false,
12	"hidden" : false,
13	"hostEnabled" : true,
14	"hostname" : "{HOSTNAME}",
15	"id" : "{HOST-ID}",
16	"ipAddress": "127.0.0.1",
17	"journalingEnabled" : false,
18	"lastDataSizeBytes" : 633208918,
19	"lastIndexSizeBytes" : 101420524,
20	"lastPing" : "2016-08-18T11:23:41Z",
21	"links" : [ ],
22	"logsEnabled" : false,
23	"lowUlimit" : false,
24	"muninEnabled" : false,
25	"port" : 26000,
26	"profilerEnabled" : false,
27	"replicaSetName": "rs1",
28	"replicaStateName" : "PRIMARY",
29	"sslEnabled" : true,
30	"systemInfo" : {
31	"memSizeMB" : 65536,
32	"numCores" : 16
33	},
34	"typeName": "REPLICA_PRIMARY",
35	"uptimeMsec": 1827300394,
36	"username" : "mongo",
37	"version" : "4.0.0"
38	},
39	{
40
41	}
42	]
43	}

注意

Resource

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

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

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

応答