1 つのホストの監視を開始

項目一覧

Resource

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

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

注意

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

新しい MongoDB プロセスの監視を開始します。モニタリングにより、指定したホスト名とポートで MongoDB プロセスのモニタリングが開始されます。 Cloud Manager は、ユーザーが提供した情報のみを認識します。応答ドキュメントには、Cloud Manager が MongoDB プロセス構成の検出を完了するまで、空白値が含まれます。

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

POST /groups/{PROJECT-ID}/hosts

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

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

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print にするかどうかを示すフラグ形式。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

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

名前	タイプ	必要性	説明
alertsEnabled	ブール値	任意	この MongoDB プロセスでアラートを有効にする必要がある場合は、 `true`に設定します。
authMechanismName	string	任意	この MongoDB プロセスに接続するために使用する認証メカニズムを指定します。可能な値は次のとおりです。 `MONGODB_CR` （これは SCRAM-SHA-1、SCRAM-SHA-256、MONGODB-CR をカバーします。） `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
Hostname	string	必須	Cloud Manager がこの MongoDB インスタンスに接続するために使用するプライマリホスト名を設定します。
logsEnabled	ブール値	任意	Cloud Manager がこの MongoDB プロセスのログを収集する必要がある場合は、 `true`に設定します。
パスワード	string	任意	この MongoDB プロセスに接続するための`username`に関連付けられたパスワード。次の場合は、このパラメーターを設定します: `"authMechanismName" : "MONGODB_CR"` Cloud Manager は、どのホスト\|\| にもこのパラメーターを含めることはありません。応答。
ポート	数値	必須	MongoDB プロセスが listen するポート。
profileEnabled	ブール値	任意	Cloud Manager がこの MongoDB プロセスからプロファイル情報を収集するかどうかを示すフラグ。
sslEnabled	ブール値	条件付き	この MongoDB プロセスでTLSを有効にするかどうかを示すフラグ。 `true`の場合は`"authMechanismName" : "MONGODB_X509"` に設定します。
username	string	条件付き	この MongoDB プロセスに接続するために必要なユーザー名。必須: `"authMechanismName" : "MONGODB_CR"`

応答

名前	タイプ	説明
aliases	文字列の配列	Cloud Manager が MongoDB プロセスのために検出したホスト名とポートの代替組み合わせの配列。これらの組み合わせには、ホスト名、 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	Cloud Manager がこの MongoDB プロセスを作成または最初に検出した日付。
グループ ID	string	このホストを所有するグループの一意の識別子。
hasStartupServings	ブール値	`true` この MongoDB プロセスに起動時の警告があった場合、。
hidden	ブール値	`true` Cloud Manager UI にホストが表示されている場合。 `true`に設定されたホストはAPI応答から省略されます。
hiddenSecondary	ブール値	`true` このホストが非表示のセカンダリである場合。
hostEnabled	ブール値	`true` MongoDB プロセスが現在有効になっている場合。
Hostname	string	Cloud 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` Cloud Manager がこの MongoDB プロセスのログを収集している場合は、。
slowUlimit	ブール値	`true` この MongoDB プロセスのホストの`ulimit`設定が低い場合。
ポート	数値	MongoDB プロセスが listen するポート。
profileEnabled	ブール値	`true` Cloud 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` Cloud Manager に追加された新しいホストのタイプは、モニタリングが最初の ping を受信するまで`NO_DATA`になります。
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
       }'

応答例

応答ヘッダー

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 201 Created
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   "authMechanismName" : "NONE",
4   "created" : "2014-04-22T19:56:50Z",
5   "groupId" : "{PROJECT-ID}",
6   "hasStartupWarnings" : false,
7   "hidden" : false,
8   "hostEnabled" : true,
9   "hostname" : "server1.example.com",
10   "id" : "{HOST-ID}",
11   "journalingEnabled" : false,
12   "links" : [  ],
13   "logsEnabled" : false,
14   "lowUlimit" : false,
15   "port" : 27017,
16   "profilerEnabled" : false,
17   "sslEnabled" : false
18   "systemInfo" : {
19     "memSizeMB" : 65536,
20     "numCores" : 16
21   },
22 }

戻る

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

Update

1	{
2	"alertsEnabled" : true,
3	"authMechanismName" : "NONE",
4	"created" : "2014-04-22T19:56:50Z",
5	"groupId" : "{PROJECT-ID}",
6	"hasStartupWarnings" : false,
7	"hidden" : false,
8	"hostEnabled" : true,
9	"hostname" : "server1.example.com",
10	"id" : "{HOST-ID}",
11	"journalingEnabled" : false,
12	"links" : [ ],
13	"logsEnabled" : false,
14	"lowUlimit" : false,
15	"port" : 27017,
16	"profilerEnabled" : false,
17	"sslEnabled" : false
18	"systemInfo" : {
19	"memSizeMB" : 65536,
20	"numCores" : 16
21	},
22	}

注意