1 つのグローバル アラートを取得
ALERT-IDで識別される 1 つのアラートを取得します。
必須のロール
割り当てられた次のいずれかのロールを使用して、このエンドポイントを正常に呼び出すことができます。
リクエスト
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /globalAlerts/{ALERT-ID}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
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 ユーザー名 。 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 の日時形式。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts/{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}
レスポンス本体
1 { 2 "alertConfigId": "{ALERT-CONFIG-ID}", 3 "created": "2019-11-30T12:42:31Z", 4 "eventTypeName": "BACKUP_AGENT_DOWN", 5 "groupId": "{PROJECT-ID}", 6 "id": "{ALERT-ID}", 7 "lastNotified": "2020-04-09T20:25:05Z", 8 "links": [ 9 ], 10 "status": "OPEN", 11 "tags": [], 12 "typeName": "AGENT", 13 "updated": "2019-11-30T12:42:31Z" 14 }