获取

描述

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 参数，则为检索到的对象的数量。

示例

检索监控项的历史数据

返回从一个 numeric(float) 监控项收到的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.