Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
MongoDB Ops Manager Administration APIリソース
/
測定値とアラート
/
グローバル アラート

1 つのグローバル アラートを確認

項目一覧

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

指定した日時まで、1 つのアラートを確認できます。 過去の日付と時刻を指定して、アラートの確認を解除することもできます。

必須のロール

割り当てられた次のいずれかのロールを使用して、このエンドポイントを正常に呼び出すことができます。

リクエスト

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

PATCH /globalAlerts/{ALERT-ID}

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

名前
タイプ
説明
ALERT-ID
string
確認対象のメンテナンスウィンドウの一意の識別子です。

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

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

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

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

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

Body Parameter
タイプ
必要性
説明
acknowledgedUntil
string
必須

ISO8601 のタイムスタンプ このアラートを確認する UTC の日付と時刻形式。この時間が経過すると、MongoDB Ops Manager はアラートを未確認に戻します。

アラートがすぐに再開されないようにするには、日付と時刻を離れた時点に設定します。

アラートを未確認にするには、過去の時刻と日付を指定します。

acknowledgementComment
string
任意
アラート確認応答を説明するコメント。

応答

名前
タイプ
説明
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

currentValue.numberの単位。 単位はメトリクスの型によって異なります。

指定できる値は次のとおりです。

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

例、メモリ消費を測定するメトリクスにはBYTESを使用でき、時間を測定するメトリクスにはHOURSを使用できます。

eventTypeName
string

アラートをトリガーしたイベントの名前。

アラートを生成するイベントの種類を確認するには、「アラートのタイプ 」を参照してください。

MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント 」を参照してください。

groupId
string
このアラートが開かれたプロジェクトの一意の識別子。
hostId
string

メトリクスが属するホストの一意の識別子。 MongoDB Ops Manager は、次のカテゴリ内のグローバル アラートに対してこのフィールドを返します。

hostnameAndPort
string

アラートが適用される各ホストのホスト名とポート。 ホスト名は、ホスト名、 FQDN 、 IPv4アドレス、またはIPv6アドレスにすることができます。 MongoDB Ops Manager は、次のカテゴリ内のグローバル アラートに対してこのフィールドを返します。

id
string
アラートの一意の識別子。
lastNotified
string
ISO8601 のタイムスタンプ このアラートの最後の通知が送信された日時の UTC 形式の日付と時刻形式。MongoDB Ops Manager が通知を送信した場合、MongoDB Ops Manager はこれを表示します。
metricName
string

値がしきい値を超えた測定値の名前。 MongoDB Ops Manager は"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"の場合にこのフィールドを返します。

可能な値については、「グローバル アラートの測定タイプ 」を参照してください。

replicaSetName
string

レプリカセットの名前。 MongoDB Ops Manager は、次のカテゴリ内のグローバル アラートに対してこのフィールドを返します。

resolved
string
ISO8601 のタイムスタンプ アラートが閉じられたときの日付と時刻形式（ UTC） 。MongoDB Ops Manager は、 "status" : "CLOSED"の場合、グローバル アラートでこのフィールドを返します。
sourceTypeName
string

バックアップされるホストのタイプ。 MongoDB Ops Manager は、バックアップの カテゴリのグローバル アラートにこのフィールドを返します。 返される可能性のある値は次のとおりです。

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

status
string

アラートの現在の状態。 返される可能性のある値は次のとおりです。

TRACKING
アラート条件は存在しますが、その条件がアラートをtriggerするのに十分な期間保持されていなかった。
OPEN
アラートが開いています。
CLOSED
アラートが閉じられます。
CANCELLED
アラートはキャンセルされます。
tags
文字列の配列
このアラートに関連付けられているタグ。
typeName
string
このフィールドは非推奨であり、無視されます。
updated
string
ISO8601 のタイムスタンプ このアラートが最後にアップデートされたときの UTC の日時形式。

リクエストの例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts/{ALERT-ID}" \
6     --data '{
7        "acknowledgedUntil":"2020-04-10T20:21:31Z",
8        "acknowledgementComment":"test"
9       }'

応答例

応答ヘッダー

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  "acknowledgedUntil": "2020-04-10T20:20:38Z",
3  "acknowledgementComment": "test",
4  "acknowledgingUsername": "rwqvzark",
5  "alertConfigId": "{ALERT-CONFIG-ID}",
6  "created": "2019-12-02T20:39:54Z",
7  "eventTypeName": "BACKUP_AGENT_DOWN",
8  "groupId": "{PROJECT-ID}",
9  "id": "{ALERT-ID}",
10  "lastNotified": "2020-04-09T20:21:31Z",
11  "links": [
12  ],
13  "status": "OPEN",
14  "tags": [],
15  "typeName": "AGENT",
16  "updated": "2020-04-10T19:14:38Z"
17}

戻る

1 つのグローバル アラートを取得

次へ

グローバル アラート構成