history.get

Описание

integer/array history.get(object parameters)

Метод позволяет получать данные истории в соответствии с заданными параметрами.

Этот метод может вернуть исторические данные удаленной сущности, если эти данные еще не были удалены housekeeper.

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках роли пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object) Параметры, определяющие требуемый результат.

Метод поддерживает следующие параметры.

Parameter Type Description
history integer Типы объектов истории, которые нужно вернуть.

Возможные значения:
0 - числовое число с плавающей точкой;
1 - символ;
2 - журнал;
3 - (по умолчанию) числовое беззнаковое;
4 - текст;
5 - двоичный;
6 - JSON.
hostids ID/array Возвращать историю только для указанных узлов сети.
itemids ID/array Возвращать историю только для указанных элементов данных.
maxValueSize integer Максимальное количество байт, которое нужно вернуть в свойстве value.

Допустимый диапазон значений: 1-134217728 (от 1 байта до 128 МиБ).
Если установлено значение null, ограничение не применяется.

По умолчанию: 65536 (64 КиБ).

Поведение параметра:
- поддерживается, если history установлено в "binary" или "JSON"
time_from timestamp Возвращать только значения, полученные после указанного времени или в указанное время.
time_till timestamp Возвращать только значения, полученные до указанного времени или в указанное время.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: itemid, clock, ns.
search object Возвращать результаты, соответствующие указанному шаблону (без учета регистра).

Принимает объект, где ключи - это имена свойств, а значения - строки для поиска. Если дополнительные параметры не указаны, будет выполнен поиск LIKE "%…%".

Не поддерживает поиск по value, если history установлено в 6 (JSON).
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 последних значений, полученных от числового элемента данных типа float.

Запрос:

{
    "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.