Table of Contents
trigger.get
Descrição
integer/array trigger.get(object parameters)
O método permite recuperar triggers 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. Consulte Funções do usuário para obter mais 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 |
|---|---|---|
| triggerids | string/array | Retornar apenas triggers com os IDs fornecidos. |
| groupids | string/array | Retornar apenas triggers que pertencem a hosts dos grupos de hosts fornecidos. |
| templateids | string/array | Retornar apenas triggers que pertencem aos modelos fornecidos. |
| hostids | string/array | Retorna apenas as triggers que pertencem aos hosts fornecidos. |
| itemids | string/array | Retorna apenas as triggers que contêm os itens fornecidos. |
| functions | string/array | Retorne apenas triggers que usam as funções fornecidas. Consulte a página de função compatível para obter uma lista de funções compatíveis. |
| group | string | Retorna apenas as triggers que pertencem a hosts do grupo de hosts com o nome fornecido. |
| host | string | Retorna apenas as triggers que pertencem ao host com o nome fornecido. |
| inherited | boolean | Se definido como true, retorna apenas triggers herdadas de um modelo. |
| templated | boolean | Se definido como true, retornará apenas as triggers que pertencem aos modelos. |
| dependent | boolean | Se definido como true, retorna apenas as triggers que possuem dependências. Se definido como false, retorne apenas as triggers que não possuem dependências. |
| monitored | flag | Retorna apenas triggers habilitadas que pertencem a hosts monitorados e contêm apenas itens habilitados. |
| active | flag | Retorna apenas triggers habilitadas que pertencem a hosts monitorados. |
| manutenção | boolean | Se definido como true, retornará apenas as triggers habilitadas que pertencem aos hosts em manutenção. |
| withUnacknowledgedEvents | flag | Retorna apenas triggers que possuem eventos não reconhecidos. |
| withAcknowledgedEvents | flag | Retorna apenas triggers com todos os eventos reconhecidos. |
| withLastEventUnacknowledged | flag | Retorna somente triggers com o último evento não reconhecido. |
| skipDependent | flag | Ignorar triggers em um estado de problema que são dependentes de outras triggers. Observe que as outras triggers são ignoradas se estiverem desabilitadas, tiverem itens desabilitados ou hosts de itens desabilitados. |
| lastChangeSince | timestamp | Retorna apenas as triggers que mudaram de estado após o tempo determinado. |
| lastChangeTill | timestamp | Retorna apenas as triggers que mudaram seu estado antes do tempo determinado. |
| only_true | flag | Retorna apenas triggers que estiveram recentemente em um estado de problema. |
| min_severity | integer | Retorna apenas triggers com gravidade maior ou igual à gravidade especificada. |
| evaltype | integer | Regras para pesquisa de etiquetas. Valores possíveis: 0 - (padrão) E/ou; 2 - Ou. |
| tags | array of objects | Retorna apenas triggers com as etiquetas fornecidas. Correspondência exata por etiquetas e pesquisa com distinção entre maiúsculas e minúsculas por valor de etiquetas, dependendo do valor do operador. Formato: [{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...].Um array vazio retorna todos as triggers. Possíveis tipos de operadores: 0 - (padrão) Like; 1 - Equal; 2 - Not like; 3 - Not equal 4 - Exists; 5 - Not exists. |
| expandComment | flag | Expandir macros na descrição da trigger . |
| expandDescription | flag | Expandir macros no nome da trigger. |
| expandExpression | flag | Expandir funções e macros na expressão da trigger. |
| selectGroups | query | Retorne os grupos de hosts aos quais a trigger pertence na propriedade groups. |
| selectHosts | query | Retorne os hosts aos quais a trigger pertence na propriedade hosts. |
| selectItems | query | Retorna os itens contidos pelo trigger na propriedade items. |
| selectFunctions | query | Retorne funções usadas na trigger na propriedade functions.Os objetos de função representam as funções usadas na expressão de trigger e possuem as seguintes propriedades: functionid - (string) ID da função;itemid - (string) ID do item usado na função;function - (string) nome da função;parameter - (string) parâmetro passado para a função. O parâmetro de consulta é substituído pelo símbolo $ na string retornada. |
| selectDependencies | query | Retorne triggers dos quais a trigger depende na propriedade dependencies. |
| selectDiscoveryRule | query | Retorne a regra de descoberta de baixo nível que criou a trigger. |
| selectLastEvent | query | Retorne o último evento de disparo significativo na propriedade lastEvent. |
| selectTags | query | Retorne as etiquetas de trigger na propriedade etiquetas. |
| selectTriggerDiscovery | query | Retorne o objeto de descoberta de trigger na propriedade triggerDiscovery. Os objetos de descoberta de trigger vinculam a trigger a um protótipo de trigger a partir do qual ele foi criado.Ele tem as seguintes propriedades: parent_triggerid - (string) ID do protótipo do gatilho a partir do qual a trigger foi criada. |
| filter | object | Retorna apenas os resultados que correspondem exatamente ao filtro fornecido. Aceita uma array, em que as chaves são nomes de propriedades e os valores são um único valor ou uma array de valores para correspondência. Suporta filtros adicionais: host - nome técnico do host ao qual a trigger pertence;hostid - ID do host ao qual a trigger pertence. |
| limitSelects | integer | Limite o número de registros retornados por subseleções. Aplica-se às seguintes subseleções: selectHosts - os resultados serão classificados por host. |
| sortfield | string/array | Classificar o resultado pelas propriedades fornecidas. Os valores possíveis são: triggerid, description, status, prioridade, lastchange e hostname. |
| 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. |
| editable | boolean | |
| excludeSearch | boolean | |
| 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
countOutputfoi usado.
Exemplos
Recuperando dados por ID de trigger
Recupere todos os dados e as funções usadas na trigger "14062".
Request:
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"triggerids": "14062",
"output": "extend",
"selectFunctions": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "14062",
"expression": "{13513}<10m",
"description": "{HOST.NAME} has been restarted (uptime < 10m)",
"url": "",
"status": "0",
"value": "0",
"priority": "2",
"lastchange": "0",
"comments": "The host uptime is less than 10 minutes",
"error": "",
"templateid": "10016",
"type": "0",
"state": "0",
"flags": "0",
"recovery_mode": "0",
"recovery_expression": "",
"correlation_mode": "0",
"correlation_tag": "",
"manual_close": "0",
"opdata": "",
"functions": [
{
"functionid": "13513",
"itemid": "24350",
"triggerid": "14062",
"parameter": "$",
"function": "last"
}
]
}
],
"id": 1
}Recuperando triggers em estado de problema
Recupere o ID, o nome e a gravidade de todos as triggers no estado do problema e classifique-as por gravidade em ordem decrescente.
Request:
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description",
"priority"
],
"filter": {
"value": 1
},
"sortfield": "priority",
"sortorder": "DESC"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "13907",
"description": "Zabbix self-monitoring processes < 100% busy",
"priority": "4"
},
{
"triggerid": "13824",
"description": "Zabbix discoverer processes more than 75% busy",
"priority": "3"
}
],
"id": 1
}Recuperando uma trigger específica com etiquetas
Recuperar uma trigger específica com etiquetas.
Request:
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description"
],
"selectTags": "extend",
"triggerids": [
"17578"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "17370",
"description": "Service status",
"tags": [
{
"tag": "service",
"value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
},
{
"tag": "error",
"value": ""
}ac
]
}
],
"id": 1
}Veja também
Fonte
CTrigger::get() in ui/include/classes/api/services/CTrigger.php.