event.get

Descrição

integer/array event.get(object parameters)

O método permite recuperar eventos de acordo com os parâmetros fornecidos.

::: não importante Este método pode retornar eventos de uma entidade excluída se esses eventos não foram removidos pela governanta ainda. :::

Este método está disponível para usuários de qualquer tipo. Permissões para chamar o método pode ser revogado nas configurações de função do usuário. Veja Usuário funções Para maiores informações.

Parâmetros

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

O método oferece suporte aos parâmetros a seguir.

Parâmetro Tipo Descrição
eventids string/array Retorna apenas eventos com os IDs fornecidos.
groupids string/array Retorna apenas eventos criados por objetos que pertencem aos grupos de hosts especificados.
hostids string/array Retorna apenas eventos criados por objetos que pertencem aos hosts fornecidos.
objectids string/array Retorna apenas eventos criados pelos objetos fornecidos.
source integer Retorna apenas eventos com o tipo fornecido.

Consulte a página do objeto do evento para obter uma lista de tipos de eventos suportados.

Padrão: 0 - acionar eventos.
objeto inteiro Retorna apenas eventos criados por objetos de um determinado tipo.

Consulte a página do objeto do evento para obter uma lista de tipos de objetos compatíveis.

Padrão : 0 - gatilho.
acknowledged boolean Se definido como true retorna apenas eventos reconhecidos.
suppressed boolean true - retorna somente eventos suprimidos;
false - retorna eventos no estado normal.
severities integer/array Retorna apenas eventos com as severidades de eventos especificadas. Aplica-se apenas se o objeto for acionador.
evaltype integer Regras para pesquisa de tags.

Valores possíveis:
0 - (padrão) E/Ou;
2 - Ou.
tags array de objetos Retorna apenas eventos com as tags fornecidas. Correspondência exata por tag e pesquisa sem distinção entre maiúsculas e minúsculas por valor e operador.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator> "}, ...].
Um array vazio retorna todos os eventos.

Possíveis tipos de operadores:
0 - (padrão) Like;
1 - Igual;
2 - Não gosta;
3 - Não é igual
4 - Existe;
5 - Não existe.
eventid_from string Retorna apenas eventos com IDs maiores ou iguais ao ID fornecido.
eventid_till string Retorna apenas eventos com IDs menores ou iguais ao ID fornecido.
time_from timestamp Retorna apenas eventos que foram criados após ou no momento determinado.
time_till timestamp Retorna apenas eventos que foram criados antes ou no momento determinado.
problem_time_from timestamp Retorna apenas eventos que estavam no estado de problema começando com problem_time_from. Aplica-se apenas se a origem for um evento de acionamento e o objeto for um acionador. Obrigatório se problem_time_till for especificado.
problem_time_till timestamp Retorna apenas eventos que estavam no estado de problema até problem_time_till. Aplica-se apenas se a origem for um evento de acionamento e o objeto for um acionador. Obrigatório se problem_time_from for especificado.
valor inteiro/array Retorna apenas eventos com os valores fornecidos.
selectHosts query Retorne uma propriedade hosts com hosts contendo o objeto que criou o evento. Com suporte apenas para eventos gerados por gatilhos, itens ou regras LLD.
selectRelatedObject query Retorna uma propriedade relatedObject com o objeto que criou o evento. O tipo de objeto retornado depende do tipo de evento.
select_alerts query Retorna uma propriedade alerts com alertas gerados pelo evento. Os alertas são classificados em ordem cronológica inversa.
select_acknowledges query Retorna uma propriedade acknowledges com atualizações de eventos. As atualizações de eventos são classificadas em ordem cronológica inversa.

O objeto de atualização de evento tem as seguintes propriedades:
acknowledgeid - ID da confirmação de (string);
userid - (string) ID do usuário que atualizou o evento;
eventid - (string) ID do evento atualizado;
clock - (timestamp) hora em que o evento foi atualizado;
message - texto (string) da mensagem;
action - (integer) ação de atualização que foi executada veja event.acknowledge;
old_severity - gravidade do evento (integer) antes desta ação de atualização;
new_severity - gravidade do evento (integer) após esta ação de atualização;
username - (string) nome de usuário do usuário que atualizou o evento;
name - (string) nome do usuário que atualizou o evento;
surname - (string) sobrenome do usuário que atualizou o evento .

Suporta contagem.
selectTags query Retorne uma propriedade tags com tags de evento.
selectSuppressionData query Retorna uma propriedade suppression_data com a lista de manutenções:
maintenanceid - (string) ID da manutenção;
suppress_until - (integer) tempo até o evento é suprimido.
sortfield string/array Ordenar o resultado pelas propriedades fornecidas.

Os valores possíveis são: eventid, objectid e clock.
countOutput boolean Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes na página comentário de referência.
editável booleano
excludePesquisa boolean
filtro objeto
limite inteiro
saída consulta
preservekeys boolean
pesquisar objeto
searchByAny boolean
searchWildcardsEnabled boolean
ordem de classificação cadeia/matriz
startSearch boolean

Valores de retorno

(integer/array) Retorna:

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

Exemplos

Recuperando eventos de gatilho

Recupere os eventos mais recentes do gatilho "13926".

Solicitação:

{
    "jsonrpc": "2.0",
    "método": "evento.get",
    "parâmetros": {
        "saída": "estender",
        "select_acknowledges": "estender",
        "selectTags": "estender",
        "selectSuppressionData": "estender",
        "objectids": "13926",
        "sortfield": ["relógio", "id do evento"],
        "ordem de classificação": "DESC"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "resultado": [
        {
            "eventid": "9695",
            "fonte": "0",
            "objeto": "0",
            "objeto": "13926",
            "relógio": "1347970410",
            "valor": "1",
            "reconhecido": "1",
            "ns": "413316245",
            "name": "MySQL está inativo",
            "gravidade": "5",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "opdata": "",
            "reconhece": [
                {
                    "reconhecimento": "1",
                    "userid": "1",
                    "eventid": "9695",
                    "relógio": "1350640590",
                    "message": "Problema resolvido.\n\r----[BULK ACKNOWLEDGE]----",
                    "ação": "6",
                    "old_severity": "0",
                    "new_severity": "0",
                    "username": "Admin",
                    "nome": "Zabbix",
                    "sobrenome": "Administrador"
                }
            ],
            "suppression_data": [
                {
                    "manutenção": "15",
                    "suppress_until": "1472511600"
                }
            ],
            "suprimido": "1",
            "Tag": [
                {
                    "tag": "serviço",
                    "valor": "mysqld"
                },
                {
                    "tag": "erro",
                    "valor": ""
                }
            ]
        },
        {
            "evento": "9671",
            "fonte": "0",
            "objeto": "0",
            "objeto": "13926",
            "relógio": "1347970347",
            "valor": "0",
            "reconhecido": "0",
            "ns": "0",
            "name": "Indisponível por ping ICMP",
            "gravidade": "4",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "opdata": "",
            "reconhece": [],
            "suppression_data": [],
            "suprimido": "0",
            "Tag": []
        }
    ],
    "id": 1
}

Recuperando eventos por período de tempo

Recupere todos os eventos que foram criados entre 9 e 10 de outubro, 2012, em ordem cronológica inversa.

Solicitação:

{
    "jsonrpc": "2.0",
    "método": "evento.get",
    "parâmetros": {
        "saída": "estender",
        "time_from": "1349797228",
        "time_till": "1350661228",
        "sortfield": ["relógio", "id do evento"],
        "sortorder": "desc"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "resultado": [
        {
            "eventid": "20616",
            "fonte": "0",
            "objeto": "0",
            "objeto": "14282",
            "relógio": "1350477814",
            "valor": "1",
            "reconhecido": "0",
            "ns": "0",
            "name": "Menos de 25% livre no cache do histórico",
            "gravidade": "3",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "opdata": "",
            "suprimido": "0"
        },
        {
            "eventid": "20617",
            "fonte": "0",
            "objeto": "0",
            "objeto": "14283",
            "relógio": "1350477814",
            "valor": "0",
            "reconhecido": "0",
            "ns": "0",
            "name": "O Zabbix Trapper processa mais de 75% ocupado",
            "gravidade": "3",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "opdata": "",
            "suprimido": "0"
        },
        {
            "eventid": "20618",
            "fonte": "0",
            "objeto": "0",
            "objeto": "14284",
            "relógio": "1350477815",
            "valor": "1",
            "reconhecido": "0",
            "ns": "0",
            "name": "Alta perda de ping ICMP",
            "gravidade": "3",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "opdata": "",
            "suprimido": "0"
        }
    ],
    "id": 1
}

Veja também

Fonte

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