history.get

Descripción

integer/array history.get(object parameters)

El método permite recuperar datos históricos de acuerdo con los parámetros suministrados.

Este método puede devolver datos históricos de una métrica eliminada si estos datos no han sido eliminados todavía por la tarea de limpieza.

::: nota clásica Este método está disponible para usuarios de cualquier tipo. Permisos llamar al método se puede revocar en la configuración de roles de usuario. Ver Usuario roles para más información. :::

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
history entero Tipos de objetos de historial a devolver.

Valores posibles:
0 - número flotante.
1 - carácter;
2 - registro;
3 - (predeterminado ) numérico sin signo;
4 - texto;
5 - binario.
hostids ID/matriz Devuelve solo el historial de los equipos dados.
itemids ID/array Devuelve solo el historial de las métricas dadas.
time_from timestamp Devuelve solo los valores que se han recibido después o en el momento indicado.
time_till marca de tiempo Devuelve solo los valores que se han recibido antes o en el momento dado.
sortfield string/array Ordena el resultado según las propiedades dadas.

Valores posibles: itemid, clock, ns.
countOutput booleano Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en la página comentario de referencia.
editable booleano
excludeSearch booleano
filter objeto
limit entero
output consulta
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/matriz
startSearch booleano

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperando datos del historial de métricas

Devuelve los 10 últimos valores recibidos de una métrica numérica (flotante).

Solicitud:

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

Respuesta:

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

Fuente

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