triggerprototype.get

Descrição

integer/array triggerprototype.get(object parameters)

O método permite recuperar protótipos de trigger 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 User roles 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	Type	Descrição
active	flag	Retorna apenas protótipos de trigger habilitados que pertencem a hosts monitorados.
discoveryids	string/array	Retorna apenas protótipos de trigger que pertencem às regras LLD fornecidas.
functions	string/array	Retorne apenas triggers que usam as funções fornecidas. Consulte a página supported trigger functions para obter uma lista de funções compatíveis.
group	string	Retorna apenas protótipos de trigger que pertencem a hosts dos grupos de hosts com o nome fornecido.
groupids	string/array	Retorna apenas protótipos de trigger que pertencem a hosts dos grupos de hosts fornecidos.
host	string	Retorna apenas protótipos de trigger que pertencem a hosts com o nome fornecido.
inherited	boolean	Se definido como `true`, retorna apenas protótipos de trigger herdados de um modelo.
manutenção	boolean	Se definido como `true` retorna apenas protótipos de trigger habilitados que pertencem a hosts em manutenção.
min_severity	integer	Retorna apenas protótipos de trigger com gravidade maior ou igual à gravidade especificada.
monitored	flag	Retorna apenas protótipos de trigger ativados que pertencem a hosts monitorados e contêm apenas itens ativados.
templated	boolean	Se definido como `true`, retornará apenas protótipos de trigger que pertencem a templates.
templateids	string/array	Retorna apenas protótipos de trigger que pertencem aos modelos fornecidos.
triggerids	string/array	Retorna apenas protótipos de trigger com os IDs fornecidos.
expandExpression	flag	Expandir funções e macros na expressão da trigger.
selectDependencies	query	Retorne protótipos de trigger e triggers dos quais o protótipo de trigger depende na propriedade `dependencies`.
selectDiscoveryRule	query	Retorne a LLD rule à qual o protótipo da trigger pertence.
selectFunctions	query	Retorna as funções usadas no protótipo do trigger na propriedade `functions`. Os objetos de função representam as funções usadas na expressão do 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.
selectGroups	query	Retorne os grupos de hosts aos quais o protótipo do trigger pertence na propriedade groups.
selectHosts	query	Retorne os hosts aos quais o protótipo do trigger pertence na propriedade hosts.
selectItems	query	Itens de retorno e protótipos de itens usaram o protótipo de trigger na propriedade items.
selectTags	query	Retorne as etiquetas de protótipo de trigger na propriedade etiquetas.
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 o protótipo da trigger pertence; `hostid` - ID do host ao qual o protótipo da 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	Ordenar o resultado pelas propriedades fornecidas. Os valores possíveis são: `triggerid`, `description`, `status` e `priority`.
countOutput	boolean	Esses parâmetros sendo comuns para todos os métodos `get` são descritos em detalhes 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

Valores de retorno

(integer/array) Retorna:

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

Exemplos

Recuperar protótipos de trigger de uma regra LLD

Recupere todos os protótipos de trigger e suas funções de uma regra LLD.

Request:

{
           "jsonrpc": "2.0",
           "method": "triggerprototype.get",
           "params": {
               "output": "extend",
               "selectFunctions": "extend",
               "discoveryids": "22450"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "13272",
                   "expression": "{12598}<20",
                   "description": "Free inodes is less than 20% on volume {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "functions": [
                       {
                           "functionid": "12598",
                           "itemid": "22454",
                           "triggerid": "13272",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               },
               {
                   "triggerid": "13266",
                   "expression": "{13500}<20",
                   "description": "Free disk space is less than 20% on volume {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "functions": [
                       {
                           "functionid": "13500",
                           "itemid": "22686",
                           "triggerid": "13266",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               }
           ],
           "id": 1
       }

Recuperando um protótipo de trigger específica com etiquetas