alerta.obter

Descrição

integer/array alert.get(object parameters)

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

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
alertids string/array Retorna apenas alertas com os IDs fornecidos.
actionids string/array Retorna apenas alertas gerados pelas ações fornecidas.
eventids string/array Retorna apenas os alertas gerados pelos eventos fornecidos.
groupids string/array Retorna apenas alertas gerados por objetos dos grupos de hosts fornecidos.
hostids string/array Retorna apenas alertas gerados por objetos dos hosts fornecidos.
mediatypeids string/array Retorna apenas alertas de mensagens que usaram os tipos de mídia fornecidos.
objectids string/array Retorna apenas alertas gerados pelos objetos fornecidos
userids string/array Retorna apenas alertas de mensagens que foram enviadas para os usuários indicados.
eventobject integer Retorna apenas alertas gerados por eventos relacionados a objetos de um determinado tipo.

Veja event "object" para obter uma lista de tipos de objetos suportados.

Padrão: 0 - trigger.
eventsource integer Retorna apenas alertas gerados por eventos de um determinado tipo.

Consulte event "source" para obter uma lista de tipos de eventos suportados .

Padrão: 0 - acionar eventos.
time_from timestamp Retorna apenas os alertas que foram gerados após o tempo determinado.
time_till timestamp Retorna apenas os alertas que foram gerados antes do tempo determinado.
selectHosts query Retorne uma propriedade hosts com dados de hosts que acionaram a operação de ação.
selectMediatypes query Retorne uma propriedade mediatypes com uma matriz dos tipos de mídia que foram usados para o alerta de mensagem.
selectUsers query Retorne uma propriedade users com um array dos usuários aos quais a mensagem foi endereçada.
sortfield string/array Ordenar o resultado pelas propriedades fornecidas.

Os valores possíveis são: alertid, clock, eventid, mediatypeid, sendto e status.
countOutput boolean Esses parâmetros sendo comuns para todos os métodos get são descritos no 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

Recuperar alertas por ID de ação

Recupera todos os alertas gerados pela ação "3".

Requisição:

{
    "jsonrpc": "2.0",
    "method": "alert.get",
    "params": {
        "output": "extend",
        "actionids": "3"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "alertid": "1",
            "actionid": "3",
            "eventid": "21243",
            "userid": "1",
            "clock": "1362128008",
            "mediatypeid": "1",
            "sendto": "[email protected]",
            "subject": "PROBLEM: Zabbix agent on Linux server is unreachable for 5 minutes: ",
            "message": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger status: PROBLEM\nTrigger severity: Not classified",
            "status": "0",
            "retries": "3",
            "error": "",
            "esc_step": "1",
            "alerttype": "0",
            "p_eventid": "0",
            "acknowledgeid": "0"
        }
    ],
    "id": 1
}

Veja também

Fonte

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