event.acknowledge

説明

object event.acknowledge(object/array parameters)

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

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

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

このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳細については、ユーザーロールを参照してください。

パラメータ

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

Parameter Type Description
eventids ID/array 確認応答するイベントのID。

Parameter behavior:
- 必須
action integer イベント更新アクション。

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

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

Parameter behavior:
- 必須
cause_eventid ID 原因イベントID。

Parameter behavior:
- action に「イベントランクを症状に変更」ビットが含まれる場合は 必須
message string メッセージのテキスト。

Parameter behavior:
- action に「メッセージを追加」ビットが含まれる場合は 必須
severity integer イベントの新しい深刻度。

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

Parameter behavior:
- action に「深刻度を変更」ビットが含まれる場合は 必須
suppress_until integer イベントを抑制する期限のUnixタイムスタンプ。

"0" に設定した場合、抑制は無期限になります。

Parameter behavior:
- action に「イベントを抑制」ビットが含まれる場合は 必須

戻り値

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

例

イベントの確認

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
}

ソース

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