history.get

Descripción

integer/array history.get(object parameters)

El método permite recuperar datos históricos según los parámetros indicados.

Este método puede devolver datos históricos de una entidad eliminada si el housekeeper aún no ha eliminado estos datos.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

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

El método admite los siguientes parámetros.

Parameter Type Description
history integer Tipos de objeto de historial que se devolverán.

Valores posibles:
0 - número flotante;
1 - carácter;
2 - log;
3 - (predeterminado) número entero sin signo;
4 - texto;
5 - binario.
hostids ID/array Devuelve solo el historial de los hosts indicados.
itemids ID/array Devuelve solo el historial de los items indicados.
time_from timestamp Devuelve solo los valores que se hayan recibido después o en el momento indicado.
time_till timestamp Devuelve solo los valores que se hayan recibido antes o en el momento indicado.
sortfield string/array Ordena el resultado por las propiedades indicadas.

Valores posibles: itemid, clock, ns.
search object Devuelve resultados que coincidan con el patrón indicado (sin distinción entre mayúsculas y minúsculas).

Acepta un objeto, donde las claves son nombres de propiedades y los valores son cadenas de texto que se van a buscar. Si no se indican opciones adicionales, esto realizará una búsqueda LIKE "%…%".

No admite la búsqueda por value si history está establecido en 6 (JSON).
countOutput boolean Estos parámetros se describen en el comentario de referencia.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(integer/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar datos históricos 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.