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 | 指定されたタイプのオブジェクトに関連するイベントによって生成されたアラートのみを返します。 サポートされているオブジェクトタイプのリストについては、 event objectを参照してください。デフォルト: 0 - トリガー |
| eventsource | integer | 指定されたタイプのイベントによって生成されたアラートのみを返します。 サポートされているイベントタイプのリストについては、event source を参照してください。デフォルト: 0 - トリガーイベント |
| time_from | timestamp | 指定された時間後に生成されたアラートのみを返します。 |
| time_till | timestamp | 指定された時間より前に生成されたアラートのみを返します。 |
| selectHosts | query | アクション操作をトリガーしたホストのデータを含むホストプロパティを返します。 |
| selectMediatypes | query | メッセージアラートに使用されたメディアタイプの配列を含むメディアタイププロパティを返します。ユーザーのタイプに基づく制限については、 mediatype.getを参照してください。 |
| selectUsers | query | メッセージの宛先となったユーザーの配列を含むユーザープロパティを返します。 |
| 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 status: 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.