history.get

描述

integer/array history.get(object parameters)

该方法允许根据给定的参数检索历史数据。

如果该数据尚未被看门狗(housekeeper)删除,则此方法可能会返回已删除实体的历史数据。

此方法适用于任何类型的用户。可以在用户角色设置中撤销调用此方法的权限。更多信息请参见 User roles

参数

(object) 定义期望输出的参数。

该方法支持以下参数。

参数 数据类型 描述
history integer 要返回的历史数据 object 类型。

可能的取值:
0 - 数值型 float;
1 - 字符型;
2 - 日志;
3 - (默认) 无符号数值型;
4 - 文本;
5 - 二进制。
hostids ID/array 仅返回来自指定 主机 的历史数据。
itemids ID/array 仅返回来自指定 监控项 的历史数据。
time_from timestamp 仅返回在指定时间之后或等于该时间接收到的值。
time_till timestamp 仅返回在指定时间之前或等于该时间接收到的值。
sortfield string/array 按照指定属性对结果进行排序。

可能的取值:itemidclockns
countOutput boolean 这些参数在 通用get方法参数 中有描述。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

返回值

(integer/array) 返回以下之一:

  • array 的 objects;
  • 如果使用了 countOutput 参数,则为检索到的 objects 的数量。

示例

检索 监控项 历史数据

返回从数值型(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() 在 ui/include/classes/api/services/CHistory.php 中。