itemprototype.get

Descripció

integer/array itemprototype.get(object parameters)

El mètode permet recuperar prototipus d'elements segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
discoveryids string/array Retorna només els prototips d'elements que pertanyen a les regles de descoberta de baix nivell especificades.
graphids string/array Retorna només els prototips d'elements emprats als prototips de gràfics donats.
hostids string/array Retorna només els prototips d'elements que pertanyen als equips donats.
inherited boolean Si s'estableix a true, només retorna prototips d'elements heretats d'una plantilla.
itemids string/array Retorna només els prototips d'elements amb els identificadors donats.
monitored boolean Si s'estableix a true, només retorna els prototips d'elements habilitats que pertanyen als equips monitorats.
template boolean Si s'estableix a true, només retorna prototips d'elements amb plantilla.
templateids string/array Retorna només els prototips d'elements que pertanyen a les plantilles donades.
triggerids string/array Retorna només els prototips d'elements emprats als prototips de trigger donats.
selectDiscoveryRule query Retorna una propietat regla de descoberta que conté la regla de descoberta de baix nivell que va crear el prototip d'element.
selectGraphs query Retorna una propietat gràfics que conté els prototips de gràfics que empren el prototip d'element.

Admet count.
selectHosts query Retorna una propietat equips que conté una matriu d'equips a què pertany el prototip d'element.
selectTags query Retorna les etiquetes del prototip d'element a la propietat etiquetes.
selectTriggers query Retorna una propietat triggers que conté els prototips de trigger que empren aquest prototip d'element.

Admet count.
selectPreprocessing query Retorna les opcions de preprocessament de l'element a la propietat preprocessing.

Té les propietats següents:
type - (cadena) Tipus d'opció preprocessament:
1 - Multiplicador personalitzat;
2 - Esborrar els espais del final;
3 - Esborrar els espais del final;
4 - Esborrar els espais del final i al final;< br>5 - Coincidència d'expressió regular;
6 - Booleà a Decimal;
7 - Octal a decimal;
8 - Hexadecimal a decimal;
9 - Canvi simple;
10 - Canvis per segon;
11 - XML ​​​​XPath;
12 - JSONPath;
13 - Dins l'interval;
14 - Coincideix amb l'expressió regular;
15 - No coincideix amb l'expressió regular;
16 - Troba un error en JSON;
17 - Troba un error en XML;
18 - Trobeu un error emprant una expressió regular;< br>19 - Esborra sense modificacions;
20 - Esborra sense modificacions amb el heartbeat;
21 - JavaScript;
22 - Patró de Prometheus;
23 - Prometeu a JSON;
24 - CSV a JSON;
25 - Substituir;
26 - Comprovar si hi ha valors no compatibles ​​;
27 - XML ​​​​a JSON.

params - (string) Paràmetres addicionals emprats per l'opció de preprocessament. Diversos paràmetres són separats per un caràcter LF (\n).
error_handler - (cadena) Tipus d'acció que s'empra en l'error del passi de preprocessament:
0 - El servidor Zabbix defineix el missatge d'error;
1 - Elimina el valor;
2 - Estableix un valor personalitzat;
3 - Estableix un missatge d'error personalitzat.

error_handler_params - (cadena) Paràmetres del gestor d'errors.
selectValueMap query Retorna una propietat mapa de valors que conté el mapa de valors del prototip d'element.
filter object Només retorna els resultats que coincideixen exactament amb el filtre donat.

Accepta una matriu on les claus són noms de propietat i els valors són un valor únic o una matriu de valors per comparar.< br>
Admet filtres addicionals:
host - Nom tècnic de l'equip al qual pertany el prototip de l'element.
limitSelects integer Limita el nombre de registres retornats per les subconsultes.

S'aplica a les subconsultes següents:
selectGraphs: els resultats s'ordenaran per nom;< br>selectTriggers: els resultats s'ordenaran per descripció.
sortfield string/array Ordena el resultat per les propietats donades.

Els valors possibles són: itemid, name, key_, delay, type i status .
countOutput boolean Aquests paràmetres, comuns a tots els mètodes get, es descriuen als comentaris 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

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar els prototips d'elements a partir d'una regla LLD

Recuperar tots els prototips d'elements per un ID específic de regla LDD.

Petició:

{
           "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
       }

Cercar un element dependent

Trobar un element dependent per l'element amb ID "25545".

Petició:

{
           "jsonrpc": "2.0",
           "method": "item.get",
           "params": {
               "output": "extend",
               "filter": {
                   "type": "18",
                   "master_itemid": "25545"
               },
               "limit": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "itemid": "25547",
                   "type": "18",
                   "snmp_oid": "",
                   "hostid": "10116",
                   "name": "Seconds",
                   "key_": "apache.status.uptime.seconds",
                   "delay": "0",
                   "history": "90d",
                   "trends": "365d",
                   "status": "0",
                   "value_type": "3",
                   "trapper_hosts": "",
                   "units": "",
                   "logtimefmt": "",
                   "templateid": "0",
                   "valuemapid": "0",
                   "params": "",
                   "ipmi_sensor": "",
                   "authtype": "0",
                   "username": "",
                   "password": "",
                   "publickey": "",
                   "privatekey": "",
                   "interfaceid": "0",
                   "description": "",
                   "evaltype": "0",
                   "master_itemid": "25545",
                   "jmx_endpoint": "",
                   "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": []
               }
           ],
           "id": 1
       }

Trobar un prototip d'element d'agent HTTP

Trobar el prototip d'element d'agent HTTP amb el mètode de consulta HEAD per a un ID d'equip específic.

Petició:

{
           "jsonrpc": "2.0",
           "method": "itemprototype.get",
           "params": {
               "hostids": "10254",
               "filter": {
                   "type": "19",
                   "request_method": "3"
               }
           },
           "id": 17,
           "auth": "d678e0b85688ce578ff061bd29a20d3b"
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "itemid": "28257",
                   "type": "19",
                   "snmp_oid": "",
                   "hostid": "10254",
                   "name": "discovered",
                   "key_": "item[{#INAME}]",
                   "delay": "{#IUPDATE}",
                   "history": "90d",
                   "trends": "30d",
                   "status": "0",
                   "value_type": "3",
                   "trapper_hosts": "",
                   "units": "",
                   "logtimefmt": "",
                   "templateid": "28255",
                   "valuemapid": "0",
                   "params": "",
                   "ipmi_sensor": "",
                   "authtype": "0",
                   "username": "",
                   "password": "",
                   "publickey": "",
                   "privatekey": "",
                   "interfaceid": "2",
                   "description": "",
                   "evaltype": "0",
                   "jmx_endpoint": "",
                   "master_itemid": "0",
                   "timeout": "3s",
                   "url": "{#IURL}",
                   "query_fields": [],
                   "posts": "",
                   "status_codes": "",
                   "follow_redirects": "0",
                   "post_type": "0",
                   "http_proxy": "",
                   "headers": [],
                   "retrieve_mode": "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",
                   "discover": "0",
                   "uuid": "",
                   "parameters": []
               }
           ],
           "id": 17
       }

Veieu també

Font

CItemPrototype::get() in ui/include/classes/api/services/CItemPrototype.php.