1 つのグローバル アラート構成によってトリガーされるすべてのオープン アラートを取得する
項目一覧
GLOBAL-ALERT-CONFIG-ID
で識別されるグローバル アラート構成によってトリガーされるすべてのオープン アラートを取得します。
必須のロール
割り当てられた次のいずれかのロールを使用して、このエンドポイントを正常に呼び出すことができます。
リクエスト
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}/alerts
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
---|---|---|---|
{GLOBAL-ALERT-CONFIG-ID} | string | 必須 | オープン アラートを検索するグローバル アラート構成の一意の識別子です。 |
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを false に設定し、 backupJobsEnabled フラグがfalse に設定されているデーモン構成を含めます。 | true |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
---|---|---|
results | 配列 | 配列には、 results 埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。 |
links | 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
totalCount | 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results
embeddedDocument
各結果は 1 つのアラートです。
名前 | タイプ | 説明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
acknowledgedUntil | string | ISO8601 のタイムスタンプ アラートが確認された UTC の日付と時刻形式。MongoDB Ops Manager は、ユーザーがこのアラートを確認した場合、このフィールドを表示します。 | ||||||||
acknowledgementComment | string | このアラートを確認したユーザーが残すコメント。 MongoDB Ops Manager は、ユーザーがこのアラートを確認した場合、このフィールドを表示します。 | ||||||||
acknowledgingUsername | string | アラートを確認したユーザーの MongoDB Ops Manager ユーザー名 。 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 |
指定できる値は次のとおりです。
例、メモリ消費を測定するメトリクスには | ||||||||
eventTypeName | string | アラートをトリガーしたイベントの名前。 アラートを生成するイベントの種類を確認するには、「アラートのタイプ 」を参照してください。 MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント 」を参照してください。 | ||||||||
groupId | string | このアラートが開かれたプロジェクトの一意の識別子。 | ||||||||
hostId | string | |||||||||
hostnameAndPort | string | |||||||||
id | string | アラートの一意の識別子。 | ||||||||
lastNotified | string | ISO8601 のタイムスタンプ このアラートの最後の通知が送信された日時の UTC 形式の日付と時刻形式。MongoDB Ops Manager が通知を送信した場合、MongoDB Ops Manager はこれを表示します。 | ||||||||
metricName | string | 値がしきい値を超えた測定値の名前。 MongoDB Ops Manager は 可能な値については、「グローバル アラートの測定タイプ 」を参照してください。 | ||||||||
replicaSetName | string | |||||||||
resolved | string | ISO8601 のタイムスタンプ アラートが閉じられたときの日付と時刻形式( UTC) 。MongoDB Ops Manager は、 "status" : "CLOSED" の場合、グローバル アラートでこのフィールドを返します。 | ||||||||
sourceTypeName | string | バックアップされるホストのタイプ。 MongoDB Ops Manager は、バックアップの カテゴリのグローバル アラートにこのフィールドを返します。 返される可能性のある値は次のとおりです。
| ||||||||
status | string | アラートの現在の状態。 返される可能性のある値は次のとおりです。
| ||||||||
tags | 文字列の配列 | このアラートに関連付けられているタグ。 | ||||||||
typeName | string | このフィールドは非推奨であり、無視されます。 | ||||||||
updated | string | ISO8601 のタイムスタンプ このアラートが最後にアップデートされたときの UTC の日時形式。 |
リクエストの例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}/alerts"
応答例
応答ヘッダー
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 "links": [], 3 "results": [{ 4 "alertConfigId": "{ALERT-CONFIG-ID}", 5 "created": "2019-11-29T20:26:30Z", 6 "eventTypeName": "BACKUP_AGENT_DOWN", 7 "groupId": "{PROJECT-ID}", 8 "id": "{ALERT-ID}", 9 "lastNotified": "2020-04-09T20:21:00Z", 10 "links": [], 11 "status": "OPEN", 12 "tags": [], 13 "typeName": "AGENT", 14 "updated": "2019-11-29T20:26:30Z" 15 }, 16 { 17 "alertConfigId": "{ALERT-CONFIG-ID}", 18 "created": "2019-11-29T20:43:00Z", 19 "eventTypeName": "BACKUP_AGENT_DOWN", 20 "groupId": "{PROJECT-ID}", 21 "id": "{ALERT-ID}", 22 "lastNotified": "2020-04-09T20:21:54Z", 23 "links": [], 24 "status": "OPEN", 25 "tags": [], 26 "typeName": "AGENT", 27 "updated": "2019-11-29T20:43:00Z" 28 }, 29 { 30 "alertConfigId": "{ALERT-CONFIG-ID}", 31 "created": "2019-11-30T12:27:07Z", 32 "eventTypeName": "BACKUP_AGENT_DOWN", 33 "groupId": "{PROJECT-ID}", 34 "id": "{ALERT-ID}", 35 "lastNotified": "2020-04-09T20:20:33Z", 36 "links": [], 37 "status": "OPEN", 38 "tags": [], 39 "typeName": "AGENT", 40 "updated": "2019-11-30T12:27:07Z" 41 } 42 ], 43 "totalCount": 3 44 }