history.get

Opis

integer/array history.get(object parameters)

Ta 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 dowolnego typu. Uprawnienia do wywołania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji znajduje się w sekcji Role użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
history integer Typy obiektów historii do zwrócenia.

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

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

Domyślnie: 65536 (64KiB).

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

Możliwe wartości: itemid, clock, ns.
search object Zwracaj wyniki pasujące do podanego wzorca (bez rozróżniania wielkości liter).

Akceptuje obiekt, w którym klucze są nazwami właściwości, a wartości są ciągami 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.