Table of Contents
itemprototype.get
Beschrijving
integer/array itemprototype.get(objectparameters)
De methode maakt het mogelijk om itemprototypes op te halen volgens de gegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| discoveryids | string/array | Retourneer alleen item-prototypes die behoren tot de gegeven LLD-regels. |
| graphids | string/array | Retourneer alleen item-prototypes die worden gebruikt in de gegeven grafiek-prototypes. |
| hostids | string/array | Retourneer alleen item-prototypes die bij de opgegeven hosts horen. |
| inherited | boolean | Indien ingesteld op true worden alleen item-prototypes geretourneerd die zijn overgenomen van een sjabloon. |
| itemids | string/array | Retourneer alleen item-prototypes met de opgegeven ID's. |
| monitored | boolean | Indien ingesteld op true retourneer alleen geactiveerde item-prototypes die behoren tot bewaakte hosts. |
| template | boolean | Indien ingesteld op true retourneert u alleen item-prototypes die bij sjablonen horen. |
| templateids | string/array | Retourneer alleen item-prototypes die bij de opgegeven sjablonen horen. |
| triggerids | string/array | Retourneer alleen item-prototypes die worden gebruikt in de gegeven trigger-prototypes. |
| selectDiscoveryRule | query | Retourneer een eigenschap discoveryRule met de detectieregel op laag niveau waartoe het prototype van het item behoort. |
| selectGraphs | query | Retourneer een eigenschap manual/api/reference/graphprototype/object#graph_prototype met grafiekprototypes waarin het prototype van het item wordt gebruikt.< br> Ondersteunt count. |
| selectHosts | query | Retourneer een eigenschap hosts met een array van hosts waartoe het prototype van het item behoort. |
| selectTags | query | Retourneer de prototypetags van het item in de eigenschap tags. |
| selectTriggers | query | Retourneer een eigenschap triggers met trigger-prototypes waarin het prototype van het item wordt gebruikt. Ondersteunt count. |
| selectPreprocessing | query | Retourneer een eigenschap preprocessing met opties voor voorbewerking van items. Het heeft de volgende eigenschappen: type - (string) Het type voorbewerkingsoptie:1 - Aangepaste vermenigvuldiger; 2 - Rechts bijsnijden; 3 - Links bijsnijden; 4 - Bijsnijden; 5 - Overeenkomstige reguliere expressies;< br>6 - Booleaans tot decimaal; 7 - Octaal tot decimaal; 8 - Hexadecimaal tot decimaal; 9 - Eenvoudige wijziging; 10 - Wijziging per seconde; 11 - XML XPath ; 12 - JSONPath; 13 - Binnen bereik; 14 - Komt overeen met reguliere expressie; 15 - Komt niet overeen met reguliere expressie; 16 - Controleer op fouten in JSON; 17 - Controleer op fouten in XML; 18 - Controleer op fouten met behulp van reguliere expressie; 19 - Negeer ongewijzigd; 20 - Verwijder ongewijzigd met hartslag; 21 - JavaScript; 22 - Prometheus-patroon; 23 - Prometheus naar JSON; 24 - CSV naar JSON; 25 - Vervang; 26 - Controleer op niet-ondersteunde waarde; 27- XML naar JSON.<br > params - (str ing) Extra parameters gebruikt door voorbewerkingsoptie. Meerdere parameters worden gescheiden door LF (\n)karakter.error_handler - (string) Actietype dat wordt gebruikt in geval van een mislukte voorverwerkingsstap:0 - Foutbericht wordt ingesteld door Zabbix-server;<br >1 - Waarde negeren; 2 - Aangepaste waarde instellen; 3 - Aangepaste foutmelding instellen. error_handler_params - (string) Parameters voor fouthandler. |
| selectValueMap | query | Retourneer een valuemap eigenschap met item prototype value map. |
| filter | object | Retourneert alleen die resultaten die exact overeenkomen met het opgegeven filter. Accepteert een array, waarbij de sleutels eigenschapsnamen zijn en de waarden een enkele waarde zijn of een array van waarden om mee te vergelijken. Ondersteunt extra filters: host - technische naam van de host waartoe het prototype van het item behoort. |
| limitSelects | integer | Beperkt het aantal records dat wordt geretourneerd door subselecties. Van toepassing op de volgende subselecties: selectGraphs - resultaten worden gesorteerd op name;selectTriggers - resultaten wordt gesorteerd op beschrijving. |
| sortfield | string/array | Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: itemid, name, key_, delay, type en status. |
| countOutput | boolean | Deze parameters gelden voor alle get-methoden en worden in detail beschreven in de referentiecommentaar. |
| editable | booleaans | |
| excludeSearch | boolean | |
| limiet | geheel getal | |
| uitvoer | query | |
| preservekeys | boolean | |
| zoeken | object | |
| searchByAny | boolean | |
| searchWildcardsIngeschakeld | boolean | |
| sortorde | string/array | |
| startZoeken | booleaans |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de parameter
countOutputheeft gebruikt.
Voorbeelden
Item-prototypes ophalen uit een LLD-regel
Haal alle itemprototypes op voor een specifieke LLD-regel-ID.
Verzoek:
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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
}Afhankelijk item zoeken
Zoek een afhankelijk item voor item met ID "25545".
Verzoek:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"filter": {
"type": "18",
"master_itemid": "25545"
},
"limit": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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
}Zoek prototype van HTTP-agentitem
Zoek prototype van HTTP-agent item met verzoekmethode HEAD voor specifieke host-ID.
Verzoek:
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"filter": {
"type": "19",
"request_method": "3"
}
},
"id": 17,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}Antwoord:
{
"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
}Zie ook
Bron
CItemPrototype::get() in ui/include/classes/api/services/CItemPrototype.php.