/ /

/ /

ホスト名とポートによる 1 つのホストの取得

注意

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

ホスト名とポートの組み合わせによって、単一の MongoDB プロセスを取得します。プライマリホスト名またはエイリアスのいずれかを指定できます。

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

Resource

GET /groups/{PROJECT-ID}/hosts/byName/{HOSTNAME}:{PORT}

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

Parameter	タイプ	必要性	説明
プロジェクトID	string	必須	この MongoDB プロセスを所有するプロジェクトの一意の識別子。
Hostname	string	必須	MongoDB Ops Manager がこのMongoDBインスタンスに接続するために使用するプライマリホスト名。このホスト名は、ホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスにすることができます。
ポート	string	必須	MongoDB プロセスが listen するポート。

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

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

名前	タイプ	必要性	説明	default
pretty	ブール値	任意	レスポンス本体をpretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTPレスポンスコード `content`: 期待される応答本体	`false`

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

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

応答

名前	タイプ	説明
aliases	文字列の配列	Array of alternate hostname and port combinations that Ops Manager discovered for the MongoDB process. These combinations can include hostnames, FQDNs, IPv4 addresses, and IPv6 addresses.
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	IPv4 or IPv6 address associated with the `hostname` of this MongoDB process. Additional accessible IPv4 or IPv6 addresses may be displayed in the `aliases` array.
journalingEnabled	ブール値	`true` この MongoDB プロセスでジャーナリングが有効になっている場合は。
lastDataSizeBytes	数値	ディスク上のホストのデータベースの非圧縮サイズ（インデックスを除く）。 `lastDataSizeBytes`にはローカルデータベース内のデータは含まれません。
lastIndexSizeBytes	数値	ディスク上のホストのデータベースインデックスの非圧縮サイズ（バイト単位）。この数にはローカルデータベースのインデックスのサイズは含まれません。
lastPing	date	このMongoDBプロセスの最後のpingが受信されたときの ISO 8601の日付と時刻形式（UTC）のタイムスタンプ。
lastRestart	date	このプロセスが最後に再起動されたときの ISO 8601の日付と時刻形式（UTC）のタイムスタンプ。 MongoDBプロセスが再起動されていない場合、`lastRestart`フィールドは省略されます。
Links	配列	サブリソースや関連リソースへの 1 つ以上のリンクを含む配列。 URL 間の関係は、 Web リンク仕様で説明されています。少なくとも、`links` 配列にはと呼ばれる 1`self` つのリンクが含まれています。
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 とが有効になっている場合。
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 のバージョン。

リクエストの例

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/byName/server1.example.com:27017?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   "alertsEnabled" : true,
3   "aliases": [ "server1.example.com:27017", "10.1.0.10:27017" ],
4   "authMechanismName" : "SCRAM-SHA-1",
5   "clusterId" : "{CLUSTER-ID}",
6   "created" : "2024-04-22T19:56:50Z",
7   "groupId" : "{PROJECT-ID}",
8   "hasStartupWarnings" : false,
9   "hidden" : false,
10   "hostEnabled" : true,
11   "hostname" : "server1.example.com",
12   "id" : "{HOST-ID}",
13   "ipAddress": "10.1.0.10",
14   "journalingEnabled" : false,
15   "lastDataSizeBytes" : 633208918,
16   "lastIndexSizeBytes" : 101420524,
17   "lastPing" : "2024-08-18T11:23:41Z",
18   "links" : [  ],
19   "logsEnabled" : false,
20   "lowUlimit" : false,
21   "muninEnabled" : false,
22   "port" : 27017,
23   "profilerEnabled" : false,
24   "replicaSetName": "rs1",
25   "replicaStateName" : "PRIMARY",
26   "sslEnabled" : true,
27   "systemInfo" : {
28     "memSizeMB" : 65536,
29     "numCores" : 16
30   },
31   "typeName": "REPLICA_PRIMARY",
32   "uptimeMsec": 1827300394,
33   "username" : "mongodb",
34   "version" : "4.4.0"
35 }

注意

MongoDB Ops Manager はレスポンスで muninEnabled を返しますが、Munin は MongoDB Ops Manager 4 以降サポートされていません。4

戻る

IDで取得

モニタリングの開始

1	{
2	"alertsEnabled" : true,
3	"aliases": [ "server1.example.com:27017", "10.1.0.10:27017" ],
4	"authMechanismName" : "SCRAM-SHA-1",
5	"clusterId" : "{CLUSTER-ID}",
6	"created" : "2024-04-22T19:56:50Z",
7	"groupId" : "{PROJECT-ID}",
8	"hasStartupWarnings" : false,
9	"hidden" : false,
10	"hostEnabled" : true,
11	"hostname" : "server1.example.com",
12	"id" : "{HOST-ID}",
13	"ipAddress": "10.1.0.10",
14	"journalingEnabled" : false,
15	"lastDataSizeBytes" : 633208918,
16	"lastIndexSizeBytes" : 101420524,
17	"lastPing" : "2024-08-18T11:23:41Z",
18	"links" : [ ],
19	"logsEnabled" : false,
20	"lowUlimit" : false,
21	"muninEnabled" : false,
22	"port" : 27017,
23	"profilerEnabled" : false,
24	"replicaSetName": "rs1",
25	"replicaStateName" : "PRIMARY",
26	"sslEnabled" : true,
27	"systemInfo" : {
28	"memSizeMB" : 65536,
29	"numCores" : 16
30	},
31	"typeName": "REPLICA_PRIMARY",
32	"uptimeMsec": 1827300394,
33	"username" : "mongodb",
34	"version" : "4.4.0"
35	}

ホスト名とポートによる 1 つのホストの取得

Resource

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

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

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

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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