Table of Contents
itemprototype.get
Descri??o
integer/array itemprototype.get(object parameters)
O m¨¦todo permite recuperar prot¨®tipos de itens de acordo com o par?metros.
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 ±«²õ³Ü¨¢°ù¾±´Ç fun??es Para maiores informa??es.
Par?metros
(object) Par?metros que definem o output desejado.
O m¨¦todo suporta os seguintes par?metros.
| Par?metro | Tipo | Descri??o |
|---|---|---|
| discoveryids | string/array | Retorna apenas prot¨®tipos de item que pertencem ¨¤s regras LLD fornecidas. |
| graphids | string/array | Retorna apenas prot¨®tipos de item que s?o usados nos prot¨®tipos de gr¨¢fico fornecidos. |
| hostids | string/array | Retorna apenas prot¨®tipos de item que pertencem aos hosts fornecidos. |
| inherited | boolean | Se definido como true , retorna apenas prot¨®tipos de item herdados de um template. |
| itemids | string/array | Retorna apenas prot¨®tipos de item com os IDs fornecidos. |
| monitored | boolean | Se definido como true , retorna apenas prot¨®tipos de item habilitados que pertencem a hosts monitorados. |
| templated | boolean | Se definido como true , retorna apenas prot¨®tipos de item que pertencem a templates. |
| templateids | string/array | Retorna apenas prot¨®tipos de item que pertencem aos templates fornecidos. |
| triggerids | string/array | Retorna apenas prot¨®tipos de item que s?o usados nos prot¨®tipos de trigger fornecidos. |
| selectDiscoveryRule | query | Retorna uma propriedade discoveryRule com a regra de descoberta de baixo n¨ªvel ¨¤ qual o prot¨®tipo de item pertence. |
| selectGraphs | query | Retorna uma propriedade graphs com prot¨®tipos de gr¨¢fico que o prot¨®tipo de item usa. Suporta count. |
| selectHosts | query | Retorna uma propriedade hosts com um array de hosts aos quais o prot¨®tipo de item pertence. |
| selectTags | query | Retorna as tags do prot¨®tipo de item na propriedade tags. |
| selectTriggers | query | Retorna uma propriedade triggers com prot¨®tipos de trigger que o prot¨®tipo de item pertece. Suporta count. |
| selectPreprocessing | query | Retorna uma propriedade preprocessing com op??es de pr¨¦-processamento de item. Possui as seguintes propriedades: type - (string) O tipo de op??o de pr¨¦-processamento:1 - Custom multiplier; 2 - Right trim; 3 - Left trim; 4 - Trim; 5 - Regular expression matching; 6 - Boolean to decimal; 7 - Octal to decimal; 8 - Hexadecimal to decimal; 9 - Simple change; 10 - Change per second; 11 - XML XPath; 12 - JSONPath; 13 - In range; 14 - Matches regular expression; 15 - Does not match regular expression; 16 - Check for error in JSON; 17 - Check for error in XML; 18 - Check for error using regular expression; 19 - Discard unchanged; 20 - Discard unchanged with heartbeat; 21 - JavaScript; 22 - Prometheus pattern; 23 - Prometheus to JSON; 24 - CSV to JSON; 25 - Replace; 26 - Check for not supported value; 27- XML to JSON. params - (string) Par?metros adicionais usados pela op??o de pr¨¦-processamento. M¨²ltiplos par?metros s?o separados por caractere LF (\n).error_handler - (string) Tipo de a??o usada em caso de falha na etapa de pr¨¦-processamento:0 - Mensagem de erro definida pelo servidor Áú»¢¶Ä²©; 1 - Descartar valor; 2 - Definir valor personalizado; 3 - Definir mensagem de erro personalizada. error_handler_params - (string) Par?metros do manipulador de erros. |
| selectValueMap | query | Retorna uma propriedade valuemap com o mapa de valor do prot¨®tipo de item. |
| filter | object | Retorna apenas os resultados que correspondem exatamente ao filtro fornecido. Aceita um array, onde as chaves s?o nomes de propriedades e os valores s?o um ¨²nico valor ou um array de valores para correspond¨ºncia. Suporta filtros adicionais: host - nome t¨¦cnico do host ao qual o prot¨®tipo de item pertence. |
| limitSelects | integer | Limita o n¨²mero de registros retornados por sub-sele??es. Aplica-se ¨¤s seguintes sub-sele??es: selectGraphs - resultados ser?o ordenados por name;selectTriggers - resultados ser?o ordenados por description. |
| sortfield | string/array | Ordena o resultado pelas propriedades fornecidas. Valores poss¨ªveis s?o: itemid, name, key_, delay, type e status. |
| countOutput | boolean | Esses par?metros sendo comuns a todos os m¨¦todos get s?o descritos em detalhes no reference commentary. |
| 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:
- um array de objetos;
- a contagem de objetos recuperados, se o par?metro
countOutputtiver sido usado.
Exemplos
Recuperando prot¨®tipos de itens de uma regra LLD
Recupere todos os prot¨®tipos de itens para um ID de regra LLD espec¨ªfico
Requisi??o:
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "23077",
"type": "0",
"snmp_oid": "",
"hostid": "10079",
"name": "Incoming network traffic on en0",
"key_": "net.if.in[en0]",
"delay": "1m",
"history": "1w",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "bps",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "0",
"description": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"discover": "0",
"uuid": "",
"parameters": []
},
{
"itemid": "10010",
"type": "0",
"snmp_oid": "",
"hostid": "10001",
"name": "Processor load (1 min average per core)",
"key_": "system.cpu.load[percpu,avg1]",
"delay": "1m",
"history": "1w",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "0",
"description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"discover": "0",
"uuid": "",
"parameters": []
}
],
"id": 1
}Encontrando item dependente
Encontre um item Dependente para o item com ID "25545".
Solicita??o:
{
"jsonrpc": "2.0",
&±ç³Ü´Ç³Ù;³¾¨¦³Ù´Ç»å´Ç&±ç³Ü´Ç³Ù;: "item.get",
"par?metros": {
&±ç³Ü´Ç³Ù;²õ²¹¨ª»å²¹&±ç³Ü´Ç³Ù;: "estender",
"filtro": {
"tipo": "18",
"master_itemid": "25545"
},
"limite": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"resultado": [
{
"itemid": "25547",
"tipo": "18",
"snmp_oid": "",
"hostid": "10116",
"nome": "Segundos",
"key_": "apache.status.uptime.seconds",
"atraso": "0",
&±ç³Ü´Ç³Ù;³ó¾±²õ³Ù¨®°ù¾±²¹&±ç³Ü´Ç³Ù;: "90d",
&±ç³Ü´Ç³Ù;³Ù±ð²Ô»å¨º²Ô³¦¾±²¹²õ&±ç³Ü´Ç³Ù;: "365d",
"estado": "0",
"value_type": "3",
"trapper_hosts": "",
"unidades": "",
&±ç³Ü´Ç³Ù;¹ó¨®°ù³¾³Ü±ô²¹&±ç³Ü´Ç³Ù;: "",
"erro": "",
"logtimefmt": "",
"templateid": "0",
"valuemap": "0",
"par?metros": "",
"ipmi_sensor": "",
"authtype": "0",
"nome do usu¨¢rio": "",
"senha": "",
"chave p¨²blica": "",
"chave privada": "",
"bandeiras": "0",
"interfaceid": "0",
"Descri??o": "",
&±ç³Ü´Ç³Ù;±ô¾±²Ô°ì³å¾±²Ô±¹±ð²Ô³Ù¨¢°ù¾±´Ç&±ç³Ü´Ç³Ù;: "0",
"vida": "30d",
"estado": "0",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"master_itemid": "0",
"tempo limite": "3s",
"url": "",
"query_fields": [],
"Postagens": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"proxy HTTP": "",
"cabe?alhos": [],
"recuperar_modo": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"¨²ltimo rel¨®gio": "0",
&±ç³Ü´Ç³Ù;¨²±ô³Ù¾±³¾´Ç²õ&±ç³Ü´Ç³Ù;: "0",
"¨²ltimo valor": "0",
"valor anterior": "0",
"descobrir": "0",
"par?metros": []
}
],
"id": 1
}Localizar prot¨®tipo de item do agente HTTP
Encontre o prot¨®tipo do item do agente HTTP com o m¨¦todo de solicita??o HEAD para ID do host.
Solicita??o:
{
"jsonrpc": "2.0",
&±ç³Ü´Ç³Ù;³¾¨¦³Ù´Ç»å´Ç&±ç³Ü´Ç³Ù;: "itemprototype.get",
"par?metros": {
"hostids": "10254",
"filtro": {
"tipo": "19",
"request_method": "3"
}
},
"id": 17,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}Resposta:
{
"jsonrpc": "2.0",
"resultado": [
{
"itemid": "28257",
"tipo": "19",
"snmp_oid": "",
"hostid": "10254",
"nome": "descoberto",
"key_": "item[{#INAME}]",
"atraso": "{#IUPDATE}",
&±ç³Ü´Ç³Ù;³ó¾±²õ³Ù¨®°ù¾±²¹&±ç³Ü´Ç³Ù;: "90d",
&±ç³Ü´Ç³Ù;³Ù±ð²Ô»å¨º²Ô³¦¾±²¹²õ&±ç³Ü´Ç³Ù;: "30d",
"estado": "0",
"value_type": "3",
"trapper_hosts": "",
"unidades": "",
&±ç³Ü´Ç³Ù;¹ó¨®°ù³¾³Ü±ô²¹&±ç³Ü´Ç³Ù;: "",
"erro": "",
"logtimefmt": "",
"templateid": "28255",
"valuemap": "0",
"par?metros": "",
"ipmi_sensor": "",
"authtype": "0",
"nome do usu¨¢rio": "",
"senha": "",
"chave p¨²blica": "",
"chave privada": "",
"bandeiras": "2",
"interfaceid": "2",
"Descri??o": "",
&±ç³Ü´Ç³Ù;±ô¾±²Ô°ì³å¾±²Ô±¹±ð²Ô³Ù¨¢°ù¾±´Ç&±ç³Ü´Ç³Ù;: "0",
"vida": "30d",
"estado": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"tempo limite": "3s",
"url": "{#IURL}",
"query_fields": [],
"Postagens": "",
"status_codes": "",
"follow_redirects": "0",
"post_type": "0",
"proxy HTTP": "",
"cabe?alhos": [],
"recuperar_modo": "0",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"descobrir": "0",
"par?metros": []
}
],
"id": 17
}Consulte tamb¨¦m
Fonte
CItemPrototype::get() in ui/include/classes/api/services/CItemPrototype.php.