history.get

Beschreibung

integer/array history.get(object parameters)

Diese Methode ermöglicht es, Verlaufsdaten entsprechend den angegebenen Parametern abzurufen.

Diese Methode kann historische Daten einer gelöschten Entität zurückgeben, wenn diese Daten noch nicht vom Housekeeper entfernt wurden.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Siehe Benutzerrollen für weitere Informationen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
history integer Zurückzugebende History-Objekttypen.

Mögliche Werte:
0 - numerischer Gleitkommawert;
1 - Zeichen;
2 - Log;
3 - (Standard) numerisch vorzeichenlos;
4 - Text;
5 - binär;
6 - JSON.
hostids ID/array Nur History der angegebenen Hosts zurückgeben.
itemids ID/array Nur History der angegebenen Datenpunkte zurückgeben.
maxValueSize integer Maximale Anzahl von Bytes, die in der Eigenschaft value zurückgegeben werden.

Möglicher Wertebereich: 1-134217728 (1 Byte bis 128MiB).
Wenn auf null gesetzt, wird keine Begrenzung angewendet.

Standard: 65536 (64KiB).

Parameter behavior:
- unterstützt, wenn history auf "binary" oder "JSON" gesetzt ist
time_from timestamp Nur Werte zurückgeben, die nach oder zum angegebenen Zeitpunkt empfangen wurden.
time_till timestamp Nur Werte zurückgeben, die vor oder zum angegebenen Zeitpunkt empfangen wurden.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: itemid, clock, ns.
search object Ergebnisse zurückgeben, die dem angegebenen Muster entsprechen (Groß-/Kleinschreibung wird nicht beachtet).

Akzeptiert ein Objekt, bei dem die Schlüssel Eigenschaftsnamen und die Werte Zeichenfolgen sind, nach denen gesucht werden soll. Wenn keine zusätzlichen Optionen angegeben sind, wird eine Suche vom Typ LIKE "%…%" durchgeführt.

Unterstützt keine Suche nach value, wenn history auf 6 (JSON) gesetzt ist.
countOutput boolean Diese Parameter sind im Referenzkommentar beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Kann die folgenden Dinge zurück geben:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Abrufen von Datenpunkt-Verlaufsdaten

Gibt die 10 zuletzt empfangenen Werte eines numerischen (float) Datenpunkts zurück.

Anfrage:

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

Antwort:

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

Quelle

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