history.get

説明

integer/array history.get(object parameters)

このメソッドは、指定されたパラメータに従って履歴データを取得するためのものです。

このメソッドは、ハウスキーパーによってまだ削除されていない場合、削除されたエンティティの履歴データを返すことがあります。

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

パラメーター

(object) 望ましい出力を定義するパラメーター。

このメソッドは以下のパラメーターをサポートします。

パラメーター タイプ 説明
history integer 返す履歴オブジェクトのタイプ。

可能な値：
0 - 数値（浮動小数点）;
1 - 文字列;
2 - ログ;
3 - (デフォルト) 数値（符号なし）;
4 - テキスト;
5 - バイナリ;
6 - JSON。
hostids ID/array 指定したホストからの履歴のみを返す。
itemids ID/array 指定したアイテムからの履歴のみを返す。
maxValueSize integer valueプロパティで返す最大バイト数。

可能な値の範囲：1-134217728（1バイトから128MiB）。
nullに設定すると、制限は適用されません。

デフォルト：65536（64KiB）。

パラメータの動作：
- historyが"binary"または"JSON"に設定されている場合にサポートされます
time_from timestamp 指定した時刻以降またはその時刻に受信した値のみを返す。
time_till timestamp 指定した時刻以前またはその時刻に受信した値のみを返す。
sortfield string/array 指定したプロパティで結果をソートする。

可能な値：itemid, clock, ns。
search object 指定したパターンに一致する結果を返す（大文字と小文字を区別しない）。

オブジェクトを受け入れ、キーはプロパティ名、値は検索する文字列です。追加オプションが指定されていない場合、LIKE "%…%"検索を実行します。

historyが6（JSON）に設定されている場合、valueによる検索はサポートされません。
countOutput boolean これらのパラメーターはリファレンス解説で説明されています。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

戻り値

(integer/array) 次のいずれかを返します:

  • オブジェクトの配列
  • countOutputパラメーターが使用されている場合、取得したオブジェクトの数

例

アイテム履歴データの取得

数値(浮動小数点)アイテムから受信した最新の10個の値を返します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "history.get",
    "params": {
        "output": "extend",
        "history": 0,
        "itemids": "23296",
        "sortfield": "clock",
        "sortorder": "DESC",
        "limit": 10
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "23296",
            "clock": "1351090996",
            "value": "0.085",
            "ns": "563157632"
        },
        {
            "itemid": "23296",
            "clock": "1351090936",
            "value": "0.16",
            "ns": "549216402"
        },
        {
            "itemid": "23296",
            "clock": "1351090876",
            "value": "0.18",
            "ns": "537418114"
        },
        {
            "itemid": "23296",
            "clock": "1351090816",
            "value": "0.21",
            "ns": "522659528"
        },
        {
            "itemid": "23296",
            "clock": "1351090756",
            "value": "0.215",
            "ns": "507809457"
        },
        {
            "itemid": "23296",
            "clock": "1351090696",
            "value": "0.255",
            "ns": "495509699"
        },
        {
            "itemid": "23296",
            "clock": "1351090636",
            "value": "0.36",
            "ns": "477708209"
        },
        {
            "itemid": "23296",
            "clock": "1351090576",
            "value": "0.375",
            "ns": "463251343"
        },
        {
            "itemid": "23296",
            "clock": "1351090516",
            "value": "0.315",
            "ns": "447947017"
        },
        {
            "itemid": "23296",
            "clock": "1351090456",
            "value": "0.275",
            "ns": "435307141"
        }
    ],
    "id": 1
}

ソース

CHistory::get() in ui/include/classes/api/services/CHistory.php.