trigger.get

Descrição

integer/array trigger.get(object parameters)

O método permite recuperar triggers de acordo com os parâmetros informados.

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 User roles 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
triggerids ID/array Retornar apenas triggers com os IDs informados.
groupids ID/array Retornar apenas triggers que pertencem a hosts ou templates dos grupos de hosts ou grupos de templates informados.
templateids ID/array Retornar apenas triggers que pertencem aos templates informados.
hostids ID/array Retornar apenas triggers que pertencem aos hosts informados.
itemids ID/array Retornar apenas triggers que contêm os items informados.
functions string/array Retornar apenas triggers que usam as funções informadas.

Consulte a página função suportada para obter uma lista de funções suportadas.
group string Retornar apenas triggers que pertencem a hosts ou templates do grupo de hosts ou grupo de templates com o nome informado.
host string Retornar apenas triggers que pertencem ao host com o nome técnico informado.
inherited boolean Se definido como true, retornar apenas triggers herdados de um template.
templated boolean Se definido como true, retornar apenas triggers que pertencem a templates.
dependent boolean Se definido como true, retornar apenas triggers que têm dependências. Se definido como false, retornar apenas triggers que não têm dependências.
monitored flag Retornar apenas triggers habilitados que pertencem a hosts monitorados e contêm apenas items habilitados.
active flag Retornar apenas triggers habilitados que pertencem a hosts monitorados.
maintenance boolean Se definido como true, retornar apenas triggers habilitados que pertencem a hosts em manutenção.
withUnacknowledgedEvents flag Retornar apenas triggers que têm eventos não reconhecidos.
withAcknowledgedEvents flag Retornar apenas triggers com todos os eventos reconhecidos.
withLastEventUnacknowledged flag Retornar apenas triggers com o último evento não reconhecido.
skipDependent flag Ignorar triggers em estado de problema que dependem de outros triggers. Observe que os outros triggers são ignorados se estiverem desabilitados, tiverem items desabilitados ou hosts de items desabilitados.
lastChangeSince timestamp Retornar apenas triggers que mudaram de estado após o horário informado.
lastChangeTill timestamp Retornar apenas triggers que mudaram de estado antes do horário informado.
only_true flag Retornar apenas triggers que estiveram em estado de problema recentemente (dentro do ok_period).
min_severity integer Retornar apenas triggers com severidade maior ou igual à severidade informada.
evaltype integer Método de avaliação de tags.

Valores possíveis:
0 - (padrão) E/OU;
2 - OU.
tags array Retornar apenas triggers com as tags informadas.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Um array vazio retorna todos os triggers.

Valores possíveis de operator:
0 - (padrão) Contém;
1 - Igual a;
2 - Não contém;
3 - Diferente de;
4 - Existe;
5 - Não existe.
expandComment flag Expandir macros na descrição do trigger.
expandDescription flag Expandir macros no nome do trigger.
expandExpression flag Expandir funções e macros na expressão do trigger.
selectHostGroups query Retornar os grupos de hosts aos quais o trigger pertence na propriedade hostgroups.
selectHosts query Retornar os hosts aos quais o trigger pertence na propriedade hosts.
selectItems query Retornar items contidos pelo trigger na propriedade items.
selectFunctions query Retornar as funções usadas no trigger na propriedade functions.

Os objetos de função representam as funções usadas na expressão do trigger e têm as seguintes propriedades:
functionid - (ID) ID da função;
itemid - (ID) 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 da consulta é substituído pelo símbolo $ na string retornada.
selectDependencies query Retornar os triggers dos quais o trigger depende na propriedade dependencies.
selectDiscoveryData query Retornar uma propriedade discoveryData com os dados do objeto de descoberta do trigger. O objeto de descoberta do trigger vincula um trigger descoberto a um protótipo de trigger a partir do qual ele foi descoberto.

Ele tem as seguintes propriedades:
parent_triggerid - (ID) ID do protótipo de trigger a partir do qual o trigger foi criado;
status - (int) status da descoberta do trigger:
0 - (padrão) trigger descoberto,
1 - trigger não é mais descoberto;
ts_delete - (timestamp) momento em que um trigger que não é mais descoberto será excluído;
ts_disable - (timestamp) momento em que um trigger que não é mais descoberto será desabilitado;
disable_source - (int) indicador de se o trigger foi desabilitado por uma regra de LLD ou manualmente:
0 - (padrão) desabilitado automaticamente,
1 - desabilitado por uma regra de LLD.
selectDiscoveryRule query Retornar a regra de descoberta de baixo nível que criou o trigger na propriedade discoveryRule.
selectLastEvent query Retornar o último evento significativo do trigger na propriedade lastEvent.
selectTags query Retornar as tags do trigger na propriedade tags.
selectTemplateGroups query Retornar os grupos de templates aos quais o trigger pertence na propriedade templategroups.
filter object Retornar apenas os resultados que correspondem exatamente ao filtro informado.

Aceita um objeto, em que as chaves são nomes de propriedades e os valores são um único valor ou um array de valores com os quais comparar.

Não oferece suporte a propriedades do tipo de dados text.

Oferece suporte a propriedades adicionais:
host - nome técnico do host ao qual o trigger pertence;
hostid - ID do host ao qual o trigger pertence.
limitSelects integer Limita o número de registros retornados pelos subselects.

Aplica-se aos seguintes subselects:
selectHosts - os resultados serão ordenados por host.
sortfield string/array Ordenar o resultado pelas propriedades informadas.

Valores possíveis: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Esses parâmetros são descritos no 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
selectTriggerDiscovery query Retornar o objeto de descoberta do trigger na propriedade triggerDiscovery. Os objetos de descoberta do trigger vinculam o trigger a um protótipo de trigger a partir do qual ele foi criado.

Esta consulta está obsoleta; use selectDiscoveryData em seu lugar.

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 por ID de trigger

Recupere todos os dados e as funções usadas no trigger "14062".

Request:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "triggerids": "14062",
        "output": "extend",
        "selectFunctions": "extend"
    },
    "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": "",
            "event_name": "",
            "uuid": "",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13513",
                    "itemid": "24350",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Recuperando triggers em estado de problema

Recupere o ID, nome e severidade de todos os triggers em estado de problema e classifique-os por severidade em ordem decrescente.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description",
            "priority"
        ],
        "filter": {
            "value": 1
        },
        "sortfield": "priority",
        "sortorder": "DESC"
    },
    "id": 1
}

Resposta:

{
    "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 um trigger específico com tags

Recupere um trigger específico com tags.

Solicitação:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description"
        ],
        "selectTags": "extend",
        "triggerids": [
            "17578"
        ]
    },
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17370",
            "description": "Service status",
            "tags": [
                {
                    "tag": "service",
                    "value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
                },
                {
                    "tag": "error",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}

Veja também

Fonte

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