注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
Resource
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}リクエスト パス パラメーター
Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 必須 | このアラートが設定されているプロジェクトの一意の識別子。 |
| string | 必須 | アラートの一意の識別子です。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
フィールド | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 条件付き | アラートを承認する期限となる、ISO 8601形式(UTC)のタイムスタンプ。
|
| string | 任意 | この確認応答の理由のテキスト説明。 MongoDB Ops Manager は、アラートが確認されたことを示すメッセージの横にコメントを表示します。 |
応答
返されるドキュメント内のフィールドは、 アラートの種類 によって異なります。
名前 | タイプ | 説明 |
|---|---|---|
| string | アラートが承認された日時(ISO 8601 形式、UTC)。 アラートが確認された場合、MongoDB Ops Manager はこの値を返します。 |
| string | アラートを確認したユーザーが残すコメント。 アラートが確認された場合、MongoDB Ops Manager はこの値を返します。 |
| string | アラートを確認したユーザーのユーザー名。 アラートが確認された場合、MongoDB Ops Manager はこの値を返します。 |
| string | このアラートをトリガーしたアラート構成の一意の識別子。 |
| string | このアラートが適用されるクラスターの一意の識別子。 MongoDB Ops Manager は次の場合にこの値を返します。 |
| string | このアラートが適用されるクラスターの名前。 MongoDB Ops Manager は次の場合にこの値を返します。 |
| string | アラートが開かれたときのISO 8601の日付と時刻形式(UTC)のタイムスタンプ。 |
| オブジェクト | アラートをトリガーしたメトリクスの現在の値。 MongoDB Ops Manager は |
| 数値 | メトリクスの値。 |
| string | 値の単位。 値は、メトリクスの型によって異なります。 たとえば、メモリ消費を測定するメトリクスにはバイト単位が含まれ、時間を測定するメトリクスには時間単位が含まれます。 MongoDB Ops Manager は次を返すことができます。
|
| string | アラートをトリガーしたイベントの名前。 指定できる値は次のとおりです。 エージェント オートメーション構成 バックアップ BI Connector クラスター Data Explorer のアクセス Host 組織 プロジェクト レプリカセット チーム user MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント 」を参照してください。 |
| string | このアラートが開かれたグループの一意の識別子。 |
| string | メトリクスが含まれるホストの一意の識別子。
|
| string | アラートが適用される各ホストするのホスト名とポート。これはホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスです。
|
| string | アラートの一意の識別子です。 |
| string | このアラートの最後の通知が送信されたときの ISO 8601 日付と時刻形式の UTC タイムスタンプ。通知が送信された場合、MongoDB Ops Manager はこの値を返します。 |
| オブジェクトの配列 | サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての |
| string | 値がしきい値を超えた測定値の名前。 MongoDB Ops Manager では、 可能な値については、「アラートの測定タイプ 」を参照してください。 |
| string | レプリカセットの名前。
|
| string | アラートがクローズされたときの日付と時刻形式( UTC )のタイムスタンプ( ISO8601 )。 MongoDB Ops Manager は |
| string | アラートの現在の状態。 MongoDB Ops Manager は次のいずれかを返すことができます。
|
| string |
|
| string 配列 | このアラートに設定された識別ラベル。 |
| string | アラートが最後に更新されたときのISO 8601の日付と時刻形式(UTC)のタイムスタンプ。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}" --data ' { "acknowledgedUntil": "2016-04-15T00:00:00-0400", "acknowledgementComment": "This is normal. Please ignore." }'応答例
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "id" : "{ALERT-CONFIG-ID}", "groupId" : "{PROJECT-ID}", "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", "status" : "OPEN", "acknowledgedUntil" : "2014-04-15T04:00:00Z", "acknowledgementComment" : "This is normal. Please ignore.", "acknowledgingUsername" : "someuser@example.com", "created" : "2014-04-03T20:28:14Z", "updated" : "2014-04-03T20:33:14Z", "lastNotified" : "2014-04-03T20:33:23Z", "metricName": "ASSERTS_REGULAR", "currentValue" : { "number" : 0.0, "units" : "RAW" }, "links" : []}