Documentation
Table of Contents
#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. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método suporta os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| alertids | ID/array | Retorna apenas alertas com os IDs fornecidos. |
| actionids | ID/array | Retorna apenas alertas gerados pelas ações fornecidas. |
| eventids | ID/array | Retorna apenas alertas gerados pelos eventos fornecidos. |
| groupids | ID/array | Retorna apenas alertas gerados por objetos dos grupos de host fornecidos. |
| hostids | ID/array | Retorna apenas alertas gerados por objetos dos hosts fornecidos. |
| mediatypeids | ID/array | Retorna apenas alertas de mensagem que usaram os tipos de mídia fornecidos. |
| objectids | ID/array | Retorna apenas alertas gerados pelos objetos fornecidos |
| userids | ID/array | Retorna apenas alertas de mensagem que foram enviados para os usuários fornecidos. |
| eventobject | integer | Retorna apenas alertas gerados por eventos relacionados a objetos do tipo fornecido. Veja o evento object para uma lista de tipos de objetos suportados.Padrão: 0 - trigger. |
| eventsource | integer | Retorna apenas alertas gerados por eventos do tipo fornecido. Veja o evento source para uma lista de tipos de eventos suportados.Padrão: 0 - eventos de trigger. |
| time_from | timestamp | Retorna apenas alertas que foram gerados após o tempo fornecido. |
| time_till | timestamp | Retorna apenas alertas que foram gerados antes do tempo fornecido. |
| selectHosts | query | Retorna uma propriedade hosts com dados dos hosts que acionaram a operação da ação. |
| selectMediatypes | query | Retorna uma propriedade mediatypes com um array dos tipos de mídia que foram usados para o alerta de mensagem.Veja mediatype.get para restrições baseadas no tipo de usuário. |
| selectUsers | query | Retorna uma propriedade users com um array dos usuários para os quais a mensagem foi endereçada.Veja user.get para restrições baseadas no tipo de usuário. |
| sortfield | string/array | Ordena o resultado pelas propriedades fornecidas. Valores possíveis: alertid, clock, eventid, mediatypeid, sendto, status. |
| countOutput | boolean | Esses parâmetros são descritos no comentário de referência. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(integer/array) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputtiver sido usado.
Exemplos
Recuperar alertas por ID de ação
Recupere todos os alertas gerados pela ação "3".
{
"jsonrpc": "2.0",
"method": "alert.get",
"params": {
"output": "extend",
"actionids": "3"
},
"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.