history.get

Descrizione

integer/array history.get(object parameters)

Il metodo consente di recuperare i dati della cronologia in base ai parametri specificati.

Questo metodo può restituire dati storici di un'entità eliminata se tali dati non sono ancora stati rimossi dall'housekeeper.

Questo metodo è disponibile per gli utenti di qualsiasi tipo. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni del ruolo utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parameter Type Description
history integer Tipi di oggetti history da restituire.

Valori possibili:
0 - float numerico;
1 - carattere;
2 - log;
3 - (predefinito) unsigned numerico;
4 - testo;
5 - binario.
hostids ID/array Restituisce solo l'history degli host specificati.
itemids ID/array Restituisce solo l'history degli item specificati.
time_from timestamp Restituisce solo i valori ricevuti dopo o alla data e ora specificata.
time_till timestamp Restituisce solo i valori ricevuti prima o alla data e ora specificata.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: itemid, clock, ns.
search object Restituisce i risultati che corrispondono al pattern 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 nella reference commentary.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
search object
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.