1 つの監視対象ホストの構成を更新
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
監視対象の MongoDB プロセスの構成を更新します。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
PATCH /groups/{PROJECT-ID}/hosts/{HOST-ID}
リクエスト パス パラメーター
Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | この MongoDB プロセスを所有するプロジェクトの一意の識別子。 |
ホスト ID | string | 必須 | MongoDB プロセスのホストの一意の識別子です。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
alertsEnabled | ブール値 | 任意 | この MongoDB プロセスでアラートを有効にする必要がある場合は、 |
authMechanismName | string | 任意 | この MongoDB プロセスに接続するために使用する認証メカニズムを指定します。 可能な値は次のとおりです。
|
logsEnabled | ブール値 | 任意 | Cloud Manager がこの MongoDB プロセスのログを収集する必要がある場合は、 |
パスワード | string | 条件付き | この MongoDB プロセスに接続するためのパスワード。 |
profileEnabled | ブール値 | 任意 | Cloud Manager がこの MongoDB プロセスからプロファイル情報を収集する場合は、 |
sslEnabled | ブール値 | 条件付き | この MongoDB プロセスでTLS / SSLを有効にする必要がある場合は、 |
username | string | 条件付き | この MongoDB プロセスに接続するために必要なユーザー名。 |
authMechanismNameがNONEの場合、ユーザー名とパスワードの既存の値はすべてクリアされます。 authMechanismNameがSCRAM-SHA-1の場合、ユーザー名とパスワードの両方を指定する必要があります。
応答
名前 | タイプ | 説明 |
|---|---|---|
aliases | 文字列の配列 | Cloud Manager が MongoDB プロセスのために検出したホスト名とポートの代替組み合わせの配列。 これらの組み合わせには、ホスト名、 FQDN 、 IPv4アドレス、およびIPv6アドレスが含まれます。 |
alertsEnabled | ブール値 |
|
authMechanismName | string | この MongoDB プロセスに接続するために使用される認証メカニズム。 これには、次のいずれかの値のみが表示されます。
|
clusterId | string | MongoDB プロセスが属するクラスターのユニーク識別子です。 |
作成済み | date | Cloud Manager がこの MongoDB プロセスを作成または最初に検出した日付。 |
グループ ID | string | このホストを所有するグループの一意の識別子。 |
hasStartupServings | ブール値 |
|
hidden | ブール値 |
|
hiddenSecondary | ブール値 |
|
hostEnabled | ブール値 |
|
Hostname | string | Cloud Manager が決定できるプライマリ ホスト名。 これは、ホスト名、 FQDN 、 IPv4アドレス、またはIPv6アドレスにすることができます。 |
id | string | Unique identifier. |
ipAddress | string | この MongoDB プロセスの |
journalingEnabled | ブール値 |
|
lastDataSizeBytes | 数値 | ディスク上のホストのデータベースの非圧縮サイズ（インデックスを除く）。 |
lastIndexSizeBytes | 数値 | ディスク上のホストのデータベース インデックスの非圧縮サイズ（バイト単位）。 この数には ローカル データベースのインデックスのサイズは含まれ ません 。 |
lastPing | date | ISO8601 のタイムスタンプ この MongoDB プロセスの最後の ping が受信されたとき、 UTC で表された日付と時刻形式。 |
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 プロセスのタイプ。 可能な値は次のとおりです。
Cloud Manager に追加された新しいホストのタイプは、モニタリングが最初の ping を受信するまで |
uptimeMsec | 数値 | このプロセスが最後に再起動されてからのミリ秒数。 |
バージョン | string | このプロセスで実行されている MongoDB のバージョン。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}?pretty=true" \ --data ' { "sslEnabled": true, "username": "mongodb", "password": "M0ng0DB!:)" }'
応答例
応答ヘッダー
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}
レスポンス本体
1 { 2 "alertsEnabled" : true, 3 "authMechanismName" : "SCRAM-SHA-1", 4 "clusterId" : "{CLUSTER-ID}", 5 "created" : "2014-04-22T19:56:50Z", 6 "groupId" : "{PROJECT-ID}", 7 "hasStartupWarnings" : false, 8 "hidden" : false, 9 "hostEnabled" : true, 10 "hostname" : "server1.example.com", 11 "id" : "{HOST-ID}", 12 "ipAddress": "10.1.0.10", 13 "journalingEnabled" : false, 14 "lastDataSizeBytes" : 470208719, 15 "lastIndexSizeBytes" : 110420592, 16 "lastPing" : "2016-08-15T17:57:12Z", 17 "links" : [ ], 18 "logsEnabled" : false, 19 "lowUlimit" : false, 20 "muninEnabled" : false, 21 "port" : 26000, 22 "profilerEnabled" : false, 23 "replicaSetName": "rs1", 24 "replicaStateName" : "SECONDARY", 25 "sslEnabled" : true, 26 "systemInfo" : { 27 "memSizeMB" : 65536, 28 "numCores" : 16 29 }, 30 "typeName": "REPLICA_SECONDARY", 31 "uptimeMsec": 489182394, 32 "username" : "mongodb", 33 "version" : "4.0.0" 34 }
注意
Cloud Manager はレスポンスで MongoDB Ops Manager を返しますが、 Monin はサポートされていません。