history.get

Beschreibung

integer/array history.get(object parameters)

Mit dieser Methode können Sie Verlaufsdaten entsprechend den angegebenen Parametern abrufen.

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

Diese Methode steht Benutzern jeden Typs zur Verfügung. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

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

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
history integer History-Objekttypen, die zurückgegeben werden sollen.

Mögliche Werte:
0 - numerischer Float;
1 - Zeichen;
2 - Log;
3 - (Standard) numerisch ohne Vorzeichen;
4 - Text;
5 - binär.
hostids ID/array Nur History von den angegebenen Hosts zurückgeben.
itemids ID/array Nur History von den angegebenen Datenpunkten zurückgeben.
time_from timestamp Nur Werte zurückgeben, die nach oder zu der angegebenen Zeit empfangen wurden.
time_till timestamp Nur Werte zurückgeben, die vor oder zu der angegebenen Zeit 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 berücksichtigt).

Akzeptiert ein Objekt, bei dem die Schlüssel Eigenschaftsnamen und die Werte Suchzeichenfolgen sind. Wenn keine zusätzlichen Optionen angegeben sind, wird eine LIKE "%…%"-Suche ausgeführt.

Unterstützt keine Suche nach value, wenn history auf 6 (JSON) gesetzt ist.
countOutput boolean Diese Parameter werden in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
search object
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.