history.get

Opis

integer/array history.get(object parameters)

Metoda umożliwia pobranie danych historycznych zgodnie z podanymi parametrami.

Ta metoda może zwrócić dane historyczne usuniętej encji, jeśli dane te nie zostały jeszcze usunięte przez housekeeper.

Ta metoda jest dostępna dla użytkowników każdego typu. Uprawnienia do wywołania metody można odebrać w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(object) Parametry definiujące oczekiwany wynik.

Metoda obsługuje następujące parametry.

Parameter Type Description
history integer Typy obiektów historii do zwrócenia.

Możliwe wartości:
0 - liczba zmiennoprzecinkowa;
1 - znak;
2 - log;
3 - (domyślnie) liczba całkowita bez znaku;
4 - tekst;
5 - binarny;
6 - JSON.
hostids ID/array Zwraca tylko historię z podanych hostów.
itemids ID/array Zwraca tylko historię z podanych pozycji.
maxValueSize integer Maksymalna liczba bajtów do zwrócenia w właściwości value.

Zakres możliwych wartości: 1-134217728 (1 bajt do 128 MiB).
Jeśli ustawiono null, nie jest stosowany żaden limit.

Domyślnie: 65536 (64 KiB).

Zachowanie parametru:
- obsługiwane jeśli history jest ustawione na "binary" lub "JSON"
time_from timestamp Zwraca tylko wartości, które zostały odebrane po podanym czasie lub dokładnie w tym czasie.
time_till timestamp Zwraca tylko wartości, które zostały odebrane przed podanym czasem lub dokładnie w tym czasie.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: itemid, clock, ns.

Nie obsługuje sortowania według ns, jeśli dane historii są przechowywane w ClickHouse.
search object Zwraca wyniki pasujące do podanego wzorca (bez uwzględniania wielkości liter).

Przyjmuje obiekt, w którym klucze są nazwami właściwości, a wartościami są ciągi znaków do wyszukania. Jeśli nie podano dodatkowych opcji, zostanie wykonane wyszukiwanie LIKE "%…%".

Nie obsługuje wyszukiwania według value, jeśli history jest ustawione na 6 (JSON).
countOutput boolean Te parametry są opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli został użyty parametr countOutput.

Przykłady

Pobieranie danych historii pozycji

Zwraca 10 najnowszych wartości otrzymanych z pozycji typu numeric(float).

Żądanie:

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

Odpowiedź:

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

Źródło

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