アラートを 1 つ取得
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/alerts/{ALERT-ID}
リクエスト パス パラメーター
Parameter | タイプ | 説明 |
|---|---|---|
プロジェクトID | string | （必須。） プロジェクト識別子。 |
ALERT-ID | string | （必須。） アラート識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
返されるドキュメント内のフィールドは、 アラートの種類 によって異なります。
名前 | タイプ | 説明 |
|---|---|---|
acknowledgedUntil | string | ISO8601 のタイムスタンプ アラートが確認されたまでの日付と時刻形式（ UTC） 。 アラートが確認された場合、MongoDB Ops Manager はこの値を返します。 |
acknowledgementComment | string | アラートを確認したユーザーが残すコメント。 アラートが確認された場合、MongoDB Ops Manager はこの値を返します。 |
acknowledgingUsername | string | アラートを確認したユーザーのユーザー名。 アラートが確認された場合、MongoDB Ops Manager はこの値を返します。 |
alertConfigId | string | このアラートをトリガーしたアラート構成の一意の識別子。 |
clusterId | string | このアラートが適用されるクラスターの一意の識別子。 MongoDB Ops Manager は次の場合にこの値を返します。
|
clusterName | string | このアラートが適用されるクラスターの名前。 MongoDB Ops Manager は次の場合にこの値を返します。
|
created | string | ISO8601 のタイムスタンプ アラートが開かれたときの UTC の日付と時刻形式。 |
currentValue | オブジェクト | アラートをトリガーしたメトリクスの現在の値。 MongoDB Ops Manager は |
currentValue.number | 数値 | メトリクスの値。 |
currentValue.units | string | 値の単位。 値は、メトリクスの型によって異なります。 たとえば、メモリ消費を測定するメトリクスにはバイト単位が含まれ、時間を測定するメトリクスには時間単位が含まれます。 MongoDB Ops Manager は次を返すことができます。
|
eventTypeName | string | アラートをトリガーしたイベントの名前。 指定できる値は次のとおりです。 エージェント オートメーション構成 Backup - BI Connector クラスター Data Explorer のアクセス Host 組織 プロジェクト レプリカセット チーム user MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント 」を参照してください。 |
groupId | string | このアラートが開かれたグループの一意の識別子。 |
hostId | string | メトリクスが含まれるホストの一意の識別子。
|
hostnameAndPort | string | アラートが適用される各ホストのホスト名とポート。 これは、ホスト名、 FQDN 、 IPv4アドレス、またはIPv6アドレスにすることができます。
|
id | string | アラートの一意の識別子です。 |
lastNotified | string | ISO8601 のタイムスタンプ このアラートの最後の通知が送信された日時の UTC 形式の日付と時刻形式。通知が送信された場合、MongoDB Ops Manager はこの値を返します。 |
links | オブジェクトの配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
metricName | string | 値がしきい値を超えた測定値の名前。 MongoDB Ops Manager では、 可能な値については、「アラートの測定タイプ 」を参照してください。 |
replicaSetName | string | レプリカセットの名前。
|
resolved | string | ISO8601 のタイムスタンプ アラートが閉じられたときの日付と時刻形式（ UTC） 。 MongoDB Ops Manager は |
status | string | アラートの現在の状態。 MongoDB Ops Manager は次のいずれかを返すことができます。
|
sourceTypeName | string |
|
tags | string 配列 | このアラートに設定された識別ラベル。 |
updated | string | ISO8601 のタイムスタンプ アラートが最後に更新されたときの UTC の日時形式。 |
アラートの測定タイプ
alertsリソースは、 metricNameフィールドに測定型を返します。 このフィールドは、 eventTypeNameがOUTSIDE_METRIC_THRESHOLDに設定されている場合にのみ存在します。
ホスト測定値
| serverStatusコマンドが生成する assertsドキュメントにある MongoDB プロセスのアサートのレート。 |
| バックグラウンドでフラッシュされるデータの量。 |
| serverStatus コマンドが生成する ドキュメントと ドキュメントにある WiredTiger ストレージ エンジン wiredTiger.cache wiredTiger.concurrentTransactionsキャッシュ内のバイト数。 |
| serverStatusコマンドが生成する connectionsドキュメントにある MongoDB プロセスへの接続の数。 |
| |
| MongoDB プロセスの Memory IssuesとPage Faultsの数。 |
| serverStatusコマンドが生成する MongoDB プロセスのロックを待機している操作の数。 MongoDB Ops Managerは、storage engine のタイプに基づいてこれらの値を計算します。 |
| インデックス b木操作の数。 |
| ジャーナリング操作 の数。 |
| serverStatusコマンドが収集する memドキュメントにある MongoDB プロセスのメモリの量。 |
| serverStatusコマンドが収集する networkドキュメントにある MongoDB プロセスのスループットの量。 |
| MongoDB プロセスのoplog の期間とスループット。 |
| MongoDB dbStatsコマンドから収集された、ディスク上のストレージ容量。 |
| serverStatusコマンドが収集する opcountersドキュメントで、プロセスが最後に開始されてからの MongoDB プロセスでのデータベース操作の速度。 |
| |
| 選択した期間中に、1 秒あたりに返される、挿入、更新、または削除されるドキュメントの平均レート。 |
| ソートを実行するが、インデックスを使用してソートを実行できない、選択した期間における 1 秒あたりの操作の平均レート。 |
| 選択した期間中の読み取り、書込み、またはコマンド操作あたりの平均実行時間（ミリ秒）。 MongoDB 3.4 以降を実行しているホストで使用できます。 |
| 過去 1 時間以内にホストが再起動した回数。 |
| 物理メモリ使用量（バイト単位）。 |
| ネットワーク スループット（1 秒あたりのバイト数単位）。 |
| 使用中のスワップ領域の合計量。 |
| explainコマンドの totalKeysExaminedの値に表示される、クエリおよびクエリプランの評価中にインデックス項目をスキャンするための 1 秒あたりの平均レート。 |
| クエリおよびクエリプランの評価中に 1 秒あたりにスキャンされるドキュメントの平均レートは、 explainコマンドの totalDocsExaminedの値にあります。 |
| 返されたドキュメント数に対するスキャンされたインデックス数の比率。 |
| 返されたドキュメント数に対するスキャンされたドキュメント数の比率。 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-ID}"
応答例
応答ヘッダー
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}
レスポンス本体
{ "alertConfigId" : "5b43d04087d9d6357de591aa", "created" : "2019-07-26T21:12:19Z", "currentValue" : { "number" : 100, "units" : "RAW" }, "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", "humanReadable" : "Project: testProj Organization: testOrg Alert acknowledged by user@example.com until 2019/10/17 19:48 GMT. Comment: N/A Connections has gone below 1000 mycluster.example.com:27017 Created: 2019/10/17 15:26 GMT Replica Set: cluster0-shard-0 Type: Primary Current Value: 100" "groupId" : "535683b3794d371327b", "hostnameAndPort" : "mycluster.example.com:27017", "id" : "533cb4b8e4b0f1820cdabc7f", "lastNotified" : "2019-07-26T21:13:48Z", "metricName" : "CONNECTIONS", "replicaSetName" : "mycluster", "resolved" : "2019-07-26T21:13:42Z", "status" : "CLOSED", "typeName" : "HOST_METRIC", "updated" : "2019-07-26T21:13:42Z", "links" : [ ... ] }