Documentation
Table of Contents
problem.get
説明
integer/array problem.get(object parameters)
このメソッドで、指定されたパラメーターに従って障害を取得できます。
このメソッドは、未解決の障害を取得するためのものです。指定されている場合は、最近解決された障害を追加で取得することもできます。 "最近"の古さを決定する期間は、管理→* 一般設定*で定義されています。 その期間より前に解決された障害は、障害テーブルに保持されません。 過去にさらに解決された障害を取得するには、event.getメソッドを使用します。
これらの障害がハウスキーパーによってまだ削除されていない場合、このメソッドは削除済みの障害を返す可能性があります。
このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。
パラメータ
(object) 目的の出力を定義するパラメーター
このメソッドは、次のパラメーターをサポートします。
| パラメータ | タイプ | 説明 |
|---|---|---|
| eventids | string/array | 指定されたIDの障害のみを返します。 |
| groupids | string/array | 指定されたホストグループに属するオブジェクトによって作成された障害のみを返します。 |
| hostids | string/array | 指定されたホストに属するオブジェクトによって作成された障害のみを返します。 |
| objectids | string/array | 指定されたオブジェクトによって作成された障害のみを返します。 |
| source | integer | 指定されたタイプの障害のみを返します。 サポートされているイベントタイプのリストについては、障害イベントオブジェクトページを参照してください。 デフォルト：0 - トリガーによって作成された障害 |
| object | integer | 指定されたタイプのオブジェクトによって作成された障害のみを返します。 サポートされているオブジェクトタイプのリストについては障害イベントオブジェクトページを参照してください。 デフォルト：0 - トリガー |
| acknowledged | boolean | true - 確認済みの障害を返しますfalse - 未確認の障害を返します |
| suppressed | boolean | true - 表示が抑制された障害を返しますfalse - 通常の状態で障害を返します |
| severities | integer/array | 指定されたイベントの深刻度に関する障害を返します。 オブジェクトがトリガーの場合にのみ適用されます。 |
| evaltype | integer | タグ検索のルール 利用可能な値： 0 - (デフォルト)And/Or 2 - Or |
| tags | array of objects | 指定されたタグの障害のみを返します。 タグによる完全一致、および値と演算子による大文字と小文字を区別しない検索。 フォーマット: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]空の配列はすべての障害を返します。 可能な演算子タイプ： 0 - (デフォルト)Like 1 - 等しい 2 - Not Like 3 - 等しくない 4 - 存在する 5 - 存在しない |
| recent | boolean | true - 障害と最近解決された障害を返します（「最近」は[Display OK]トリガーのN秒表示に依存します）デフォルト： false-未解決の問題のみ |
| eventid_from | string | 指定されたID以上のIDを持つ障害を返します。 |
| eventid_till | string | 指定されたID以下のIDの障害を返します。 |
| time_from | timestamp | 指定された時間以降に作成された障害を返します。 |
| time_till | timestamp | 指定された時間以前に作成された障害を返します。 |
| selectAcknowledges | query | 障害の更新とともにacknowledgesプロパティを返します。 障害の更新は、時系列の逆順に並べ替えられます。障害の更新オブジェクトには次のプロパティがあります。 acknowledgeid - （string）更新のIDuserid-（string）イベントを更新したユーザーのIDeventid-（文字列）更新されたイベントのID clock-（タイムスタンプ）イベントが更新された時刻message-（string）メッセージのテキストaction-（integer）更新アクションのタイプ（event.acknowledgeを参照）old_severity-（integer）この更新アクション前のイベントの深刻度new_severity-（integer）この更新アクション後のイベントの深刻度countをサポートします。 |
| selectTags | query | 障害のあるタグを含むtagsプロパティを返します。フォーマット： [{"tag": "<tag>", "value": "<value>"}, ...] |
| selectSuppressionData | query | メンテナンスのリストを含むsuppression_dataプロパティを返します。maintenanceid-（string）メンテナンスのIDsuppress_until-（integer）問題が抑制されるまでの時間。 |
| sortfield | string/array | 指定されたプロパティで結果を並べ替えます。 可能な値は次のとおりです： eventid |
| countOutput | boolean | すべてのgetメソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。 |
| 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パラメータが使用されている場合、取得されたオブジェクトの数
例
トリガーの障害イベント取得
トリガー"15112"から最近のイベントを取得します。
Request:
{
"jsonrpc": "2.0",
"method": "problem.get",
"params": {
"output": "extend",
"selectAcknowledges": "extend",
"selectTags": "extend",
"selectSuppressionData": "extend",
"objectids": "15112",
"recent": "true",
"sortfield": ["eventid"],
"sortorder": "DESC"
},
"auth": "67f45d3eb1173338e1b1647c4bdc1916",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"eventid": "1245463",
"source": "0",
"object": "0",
"objectid": "15112",
"clock": "1472457242",
"ns": "209442442",
"r_eventid": "1245468",
"r_clock": "1472457285",
"r_ns": "125644870",
"correlationid": "0",
"userid": "1",
"name": "Zabbix agent on localhost is unreachable for 5 minutes",
"acknowledged": "1",
"severity": "3",
"opdata": "",
"acknowledges": [
{
"acknowledgeid": "14443",
"userid": "1",
"eventid": "1245463",
"clock": "1472457281",
"message": "problem solved",
"action": "6",
"old_severity": "0",
"new_severity": "0"
}
],
"suppression_data": [
{
"maintenanceid": "15",
"suppress_until": "1472511600"
}
],
"suppressed": "1",
"tags": [
{
"tag": "test tag",
"value": "test value"
}
]
}
],
"id": 1
}参照
ソース
CEvent::get() in ui/include/classes/api/services/CProblem.php.