history.get

Descrição

integer/array history.get(object parameters)

O método permite recuperar dados históricos de acordo com os parâmetros fornecidos.

Este método pode retornar dados históricos de uma entidade excluída se esses dados ainda não tiverem sido removidos pelo housekeeper.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Consulte Funções de usuário para obter mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parameter Type Description
history integer Tipos de objeto de histórico a retornar.

Valores possíveis:
0 - float numérico;
1 - caractere;
2 - log;
3 - (padrão) numérico sem sinal;
4 - texto;
5 - binário;
6 - JSON.
hostids ID/array Retorna apenas o histórico dos hosts informados.
itemids ID/array Retorna apenas o histórico dos items informados.
maxValueSize integer Número máximo de bytes a retornar na propriedade value.

Intervalo de valores possíveis: 1-134217728 (1 byte a 128MiB).
Se definido como null, nenhum limite é aplicado.

Padrão: 65536 (64KiB).

Comportamento do parâmetro:
- supported se history estiver definido como "binary" ou "JSON"
time_from timestamp Retorna apenas valores que foram recebidos após ou no horário informado.
time_till timestamp Retorna apenas valores que foram recebidos antes ou no horário informado.
sortfield string/array Classifica o resultado pelas propriedades informadas.

Valores possíveis: itemid, clock, ns.

Não oferece suporte à classificação por ns se os dados de histórico estiverem armazenados no ClickHouse.
search object Retorna resultados que correspondem ao padrão informado (sem diferenciar maiúsculas de minúsculas).

Aceita um objeto, em que as chaves são nomes de propriedades e os valores são strings a serem pesquisadas. Se nenhuma opção adicional for informada, isso executará uma pesquisa LIKE "%…%".

Não oferece suporte à pesquisa por value se history estiver definido como 6 (JSON).
countOutput boolean Esses parâmetros são descritos no comentário de referência.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(integer/array) Retorna:

  • um array de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando dados históricos de item

Retorna os 10 últimos valores recebidos de um item numérico (float).

Requisição:

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

Resposta:

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

Fonte

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