event.acknowledge

説明

object event.acknowledge(object/array parameters)

このメソッドを使用すると、イベントを更新できます。 実行できる更新アクションは次のとおりです。

  • イベントをクローズする。 イベントがすでに解決済みの場合、このアクションはスキップされます。
  • イベントを承認する。 イベントがすでに承認済みの場合、このアクションはスキップされます。
  • イベントの承認を取り消す。 イベントが承認されていない場合、このアクションはスキップされます。
  • メッセージを追加する。
  • イベントの深刻度を変更する。 イベントがすでに同じ深刻度を持つ場合、このアクションはスキップされます。
  • イベントを抑制する。 イベントがすでに抑制されている場合、このアクションはスキップされます。
  • イベントの抑制を解除する。 イベントが抑制されていない場合、このアクションはスキップされます。
  • イベントのランクを原因に変更する。 イベントがすでに原因としてランク付けされている場合、このアクションはスキップされます。
  • イベントのランクを症状に変更する。 イベントがすでに症状としてランク付けされている場合、このアクションはスキップされます。

更新できるのはトリガーイベントのみです。
更新できるのは障害イベントのみです。
イベントをクローズするか、イベントの深刻度を変更するには、トリガーに対する読み取り/書き込み権限が必要です。
イベントをクローズするには、トリガーで手動クローズが許可されている必要があります。

このメソッドは、すべての種類のユーザーが利用できます。 このメソッドを呼び出す権限は、ユーザーの役割設定で取り消すことができます。 詳細はユーザーの役割を参照してください。

パラメーター

(object/array) イベントのIDと、実行する更新操作を含むパラメーター。

Parameter Type Description
eventids ID/array 障害のうち、確認する対象のID。

Parameter behavior:
- required
action integer イベント更新の操作。

指定可能なビットマップ値:
1 - 障害をクローズ;
2 - イベントを確認;
4 - メッセージを追加;
8 - 深刻度を変更;
16 - イベントの確認を解除;
32 - イベントを抑制;
64 - イベントの抑制を解除;
128 - イベントのランクを原因に変更;
256 - イベントのランクを症状に変更。

これはビットマスクフィールドです。指定可能なビットマップ値の合計を任意に指定できます（たとえば、イベントの確認と抑制を行う場合は 34）。

Parameter behavior:
- required
cause_eventid ID 原因イベントのID。

Parameter behavior:
- required if action contains the "change event rank to symptom" bit
message string メッセージのテキスト。

Parameter behavior:
- required if action contains the "add message" bit
severity integer イベントの新しい深刻度。

指定可能な値:
0 - 未分類;
1 - 情報;
2 - 警告;
3 - 平均;
4 - 高;
5 - 重大。

Parameter behavior:
- required if action contains the "change severity" bit
suppress_until integer イベントを抑制する Unix タイムスタンプ。

"0" に設定すると、抑制は無期限になります。

Parameter behavior:
- required if action contains the "suppress event" bit

戻り値

(object) 更新されたイベントの ID を eventids プロパティに含むオブジェクトを返します。

例

イベントの確認

1つのイベントを確認し、メッセージを残します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 6,
        "message": "Problem resolved."
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427"
        ]
    },
    "id": 1
}

イベントの深刻度の変更

複数のイベントの深刻度を変更し、メッセージを残します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": ["20427", "20428"],
        "action": 12,
        "message": "Maintenance required to fix it.",
        "severity": 4
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427",
            "20428"
        ]
    },
    "id": 1
}

Suppressing an event indefinitely

Suppress a single event without an expiration time.

Request:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 32,
        "suppress_until": 0
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            20427
        ]
    },
    "id": 1
}

Unsuppressing an event

Unsuppress a single previously suppressed event.

Request:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 64
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            20427
        ]
    },
    "id": 1
}

Acknowledge and suppress an event

Acknowledge one or more events, add a message, and suppress them in the same request.

Request:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": [
            "20427",
            "20428"
        ],
        "action": 38,
        "message": "Suppressing during planned maintenance.",
        "suppress_until": 0
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            20427,
            20428
        ]
    },
    "id": 1
}

ソース

CEvent::acknowledge() in ui/include/classes/api/services/CEvent.php.