注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
新しい MongoDB プロセスの監視を開始します。 モニタリングにより、指定したホスト名とポートで MongoDB プロセスのモニタリングが開始されます。 MongoDB Ops Manager は、提供された情報のみを認識します。 応答ドキュメントには、 MongoDB Ops ManagerがMongoDBプロセス構成の検出を完了するまで空白の値が含まれます。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/hostsリクエスト パス パラメーター
Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | この MongoDB プロセスを所有するプロジェクトの一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
alertsEnabled | ブール値 | 任意 | この MongoDB プロセスでアラートを有効にする必要がある場合は、 |
authMechanismName | string | 任意 | この MongoDB プロセスに接続するために使用する認証メカニズムを指定します。 可能な値は次のとおりです。
|
Hostname | string | 必須 | MongoDB Ops Manager がこの MongoDB インスタンスに接続するために使用するプライマリ ホスト名を設定します。 |
logsEnabled | ブール値 | 任意 | MongoDB Ops ManagerがこのMongoDBプロセスのログを収集する必要がある場合は、 |
パスワード | string | 任意 | この MongoDB プロセスに接続するための 次の場合は、このパラメーターを設定します: MongoDB Ops Manager はどのホスト || にもこのパラメーターを含めることはありません。応答。 |
ポート | 数値 | 必須 | MongoDB プロセスが listen するポート。 |
profileEnabled | ブール値 | 任意 | MongoDB Ops ManagerがこのMongoDBプロセスからプロファイル情報を収集するかどうかを示すフラグ。 |
sslEnabled | ブール値 | 条件付き | この MongoDB プロセスでTLSを有効にするかどうかを示すフラグ。
|
username | string | 条件付き | この MongoDB プロセスに接続するために必要なユーザー名。 必須: |
応答
名前 | タイプ | 説明 |
|---|---|---|
aliases | 文字列の配列 | MongoDB プロセスに対して MongoDB Ops Manager が検出した代替のホスト名とポートの組み合わせの配列。これらの組み合わせには、ホスト名、FQDN、IPv4 アドレス、および IPv6 アドレスが含まれます。 |
alertsEnabled | ブール値 |
|
authMechanismName | string | この MongoDB プロセスに接続するために使用される認証メカニズム。 これには、次のいずれかの値のみが表示されます。
|
clusterId | string | MongoDB プロセスが属するクラスターのユニーク識別子です。 |
作成済み | date | MongoDB Ops Manager がこの MongoDB プロセスを作成または最初に検出した日付。 |
グループ ID | string | このホストを所有するグループの一意の識別子。 |
hasStartupServings | ブール値 |
|
hidden | ブール値 |
|
hiddenSecondary | ブール値 |
|
hostEnabled | ブール値 |
|
Hostname | string | MongoDB Ops Manager が最適に判断できるプライマリホスト名。これはホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスです。 |
id | string | Unique identifier. |
ipAddress | string | この MongoDB プロセスの |
journalingEnabled | ブール値 |
|
lastDataSizeBytes | 数値 | ディスク上のホストのデータベースの非圧縮サイズ（インデックスを除く）。 |
lastIndexSizeBytes | 数値 | ディスク上のホストのデータベース インデックスの非圧縮サイズ（バイト単位）。 この数には ローカル データベースのインデックスのサイズは含まれ ません 。 |
lastPing | date | このMongoDBプロセスの最後のpingが受信されたときの ISO の日付と時刻形式のタイムスタンプ（UTC）。8601 |
lastRestart | date | このプロセスが最後に再起動されたときの ISO8601 の日付と時刻形式（UTC）のタイムスタンプ。 MongoDBプロセスが再起動されていない場合、 |
Links | 配列 | サブリソースや関連リソースへの 1 つ以上のリンクを含む配列。URL 間の関係は、Web リンク仕様 で説明されています。少なくとも、 |
logsEnabled | ブール値 |
|
slowUlimit | ブール値 |
|
ポート | 数値 | MongoDB プロセスが listen するポート。 |
profileEnabled | ブール値 |
|
ReplicaSetName | string | このプロセスが属するレプリカセットの名前。 このプロセスがレプリカセットの一部である場合にのみ存在します。 |
replicaStateName | string | レプリカセット内のこの MongoDB プロセスの現在の状態。 このプロセスがレプリカセットの一部である場合にのみ存在します。 可能な値については、「レプリカセット ノードの状態 」を参照してください。 |
shardName | string | このプロセスが属するシャードの名前。 プロセスがシャーディングされたクラスターの一部である場合にのみ存在します。 |
secondaryDelaySecs | 数値 | このレプリカセットメンバーのデータがプライマリより続く秒数。 この値が |
sslEnabled | ブール値 |
|
systemInfo | オブジェクト | オペレーティング システムまたはコンテナによって報告される、この MongoDB プロセスのサーバーの RAM および CPU 情報を含むオブジェクト。 |
systemInfo.memSizeMB | 数値 | RAM の量（メガバイト単位）。 |
systemInfo.numCores | 数値 | CPU コアの数。 |
typeName | string | この MongoDB プロセスのタイプ。 可能な値は次のとおりです。
MongoDB Ops Manager に追加された新しいホストのタイプは、モニタリングが最初の ping を受信するまで |
uptimeMsec | 数値 | このプロセスが最後に再起動されてからのミリ秒数。 |
バージョン | string | このプロセスで実行されている MongoDB のバージョン。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts?pretty=true" \ --data ' { "hostname": "server1.example.com", "port": 27017 }'curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/hosts?pretty=true" \ --data ' { "hostname": "server1.example.com", "port": 27017 }'応答例
応答ヘッダー
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-aliveHTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "alertsEnabled" : true, "authMechanismName" : "NONE", "created" : "2014-04-22T19:56:50Z", "groupId" : "{PROJECT-ID}", "hasStartupWarnings" : false, "hidden" : false, "hostEnabled" : true, "hostname" : "server1.example.com", "id" : "{HOST-ID}", "journalingEnabled" : false, "links" : [ ], "logsEnabled" : false, "lowUlimit" : false, "port" : 27017, "profilerEnabled" : false, "sslEnabled" : false "systemInfo" : { "memSizeMB" : 65536, "numCores" : 16 },}