alert.get
説明
integer/array alert.get(object parameters)
このメソッドは、指定されたパラメーターに従ってアラートを取得できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメーター
(object) 望ましい出力を定義するパラメーター。
このメソッドは以下のパラメーターをサポートします。
| パラメーター | タイプ | 説明 |
|---|---|---|
| alertids | ID/array | 指定したIDのアラートのみを返します。 |
| actionids | ID/array | 指定したアクションによって生成されたアラートのみを返します。 |
| eventids | ID/array | 指定したイベントによって生成されたアラートのみを返します。 |
| groupids | ID/array | 指定したホストグループのオブジェクトによって生成されたアラートのみを返します。 |
| hostids | ID/array | 指定したホストのオブジェクトによって生成されたアラートのみを返します。 |
| mediatypeids | ID/array | 指定したメディアタイプを使用したメッセージアラートのみを返します。 |
| objectids | ID/array | 指定したオブジェクトによって生成されたアラートのみを返します |
| userids | ID/array | 指定したユーザーに送信されたメッセージアラートのみを返します。 |
| eventobject | integer | 指定したタイプのオブジェクトに関連するイベントによって生成されたアラートのみを返します。 サポートされているオブジェクトタイプのリストについては、イベント object を参照してください。デフォルト: 0 - トリガー。 |
| eventsource | integer | 指定したタイプのイベントによって生成されたアラートのみを返します。 サポートされているイベントタイプのリストについては、イベント source を参照してください。デフォルト: 0 - トリガーイベント。 |
| time_from | timestamp | 指定した時刻以降に生成されたアラートのみを返します。 |
| time_till | timestamp | 指定した時刻以前に生成されたアラートのみを返します。 |
| selectHosts | query | アクション操作をトリガーしたホストのデータを持つ hosts プロパティを返します。 |
| selectMediatypes | query | メッセージアラートで使用されたメディアタイプの配列を持つ mediatypes プロパティを返します。ユーザータイプによる制限については、 mediatype.get を参照してください。 |
| selectUsers | query | メッセージが送信されたユーザーの配列を持つ users プロパティを返します。ユーザータイプによる制限については、 user.get を参照してください。 |
| sortfield | string/array | 指定したプロパティで結果をソートします。 可能な値: alertid, clock, eventid, mediatypeid, sendto, status. |
| countOutput | boolean | これらのパラメーターはリファレンス解説で説明されています。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメーターが使用されている場合、取得したオブジェクトの数
例
アクションIDによるアラートの取得
アクション"3"によって生成されたすべてのアラートを取得します。
{
"jsonrpc": "2.0",
"method": "alert.get",
"params": {
"output": "extend",
"actionids": "3"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"alertid": "1",
"actionid": "3",
"eventid": "21243",
"userid": "1",
"clock": "1362128008",
"mediatypeid": "1",
"sendto": "[email protected]",
"subject": "PROBLEM: Zabbix agent on Linux server is unreachable for 5 minutes: ",
"message": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger state: PROBLEM\nTrigger severity: Not classified",
"status": "0",
"retries": "3",
"error": "",
"esc_step": "1",
"alerttype": "0",
"p_eventid": "0",
"acknowledgeid": "0"
}
],
"id": 1
}参照
ソース
CAlert::get() in ui/include/classes/api/services/CAlert.php.