history.get

Descrizione

integer/array history.get(object parameters)

Il metodo consente di recuperare i dati dello storico in base ai parametri specificati.

Questo metodo può restituire i dati dello storico di un'entità eliminata se questi dati non sono ancora stati rimossi dal processo di housekeeping.

Questo metodo è disponibile per utenti di qualsiasi tipo. I permessi per chiamare il metodo possono essere revocati nelle impostazioni dei ruoli utente. Consultare Ruoli utente per ulteriori informazioni.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Tipo Descrizione
history integer Tipi di oggetti history da restituire.

Valori possibili:
0 - numerico in virgola mobile;
1 - carattere;
2 - log;
3 - (predefinito) numerico senza segno;
4 - testo;
5 - binario;
6 - JSON.
hostids ID/array Restituisce solo la history dei host specificati.
itemids ID/array Restituisce solo la history degli item specificati.
maxValueSize integer Numero massimo di byte da restituire nella proprietà value.

Intervallo di valori possibili: 1-134217728 (da 1 byte a 128MiB).
Se impostato su null, non viene applicato alcun limite.

Predefinito: 65536 (64KiB).

Comportamento del parametro:
- supportato se history è impostato su "binary" o "JSON"
time_from timestamp Restituisce solo i valori ricevuti dopo o al momento specificato.
time_till timestamp Restituisce solo i valori ricevuti prima o al momento specificato.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: itemid, clock, ns.
search object Restituisce i risultati che corrispondono al modello specificato (senza distinzione tra maiuscole e minuscole).

Accetta un oggetto in cui le chiavi sono nomi di proprietà e i valori sono stringhe da cercare. Se non vengono fornite opzioni aggiuntive, verrà eseguita una ricerca LIKE "%…%".

Non supporta la ricerca per value se history è impostato su 6 (JSON).
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce:

  • un array di oggetti;
  • il conteggio degli oggetti recuperati, se è stato utilizzato il parametro countOutput.

Esempi

Recuperare dei dati dallo storico degli elementi

Restituisce gli ultimi 10 valori ricevuti da un elemento numerico (float).

Richiesta:

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

Risposta:

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

Sorgente

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