Documentation
Table of Contents
itemprototype.get
Beschrijving
integer/array itemprototype.get(object parameters)
Deze methode maakt het mogelijk om item-prototypes op te halen aan de hand van de opgegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode te gebruiken kan worden ingetrokken in de gebruikersrol-instellingen. Zie Gebruikersrollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| discoveryids | string/array | Geef alleen item-prototypes terug die behoren tot de opgegeven LLD-regels. |
| graphids | string/array | Geef alleen item-prototypes terug die worden gebruikt in de opgegeven grafiek-prototypes. |
| hostids | string/array | Geef alleen item-prototypes terug die behoren tot de opgegeven hosts. |
| inherited | boolean | Indien ingesteld op true, geef alleen geërfde item-prototypes terug van een template. |
| itemids | string/array | Geef alleen item-prototypes terug met de opgegeven IDs. |
| monitored | boolean | Indien ingesteld op true, geef alleen ingeschakelde item-prototypes terug die behoren tot gemonitorde hosts. |
| templated | boolean | Indien ingesteld op true, geef alleen item-prototypes terug die behoren tot templates. |
| templateids | string/array | Geef alleen item-prototypes terug die behoren tot de opgegeven templates. |
| triggerids | string/array | Geef alleen item-prototypes terug die worden gebruikt in de opgegeven trigger-prototypes. |
| selectDiscoveryRule | query | Geef een eigenschap discoveryRule terug met de laag-niveau ontdekkingsregel waartoe de item-prototype behoort. |
| selectGraphs | query | Geef een eigenschap graphs terug met grafiek-prototypes waartoe de item-prototype wordt gebruikt. Ondersteunt count. |
| selectHosts | query | Geef een eigenschap hosts terug met een array van hosts waartoe de item-prototype behoort. |
| selectTags | query | Geef de tags van de item-prototype terug in de eigenschap tags. |
| selectTriggers | query | Geef een eigenschap triggers terug met trigger-prototypes waartoe de item-prototype wordt gebruikt. Ondersteunt count. |
| selectPreprocessing | query | Geef een eigenschap preprocessing terug met opties voor item-prototype voorbewerking. Het heeft de volgende eigenschappen: type - (string) Het type voorbewerkingsoptie:1 - Aangepaste vermenigvuldiger; 2 - Rechts trimmen; 3 - Links trimmen; 4 - Trimmen; 5 - Overeenkomst met reguliere expressie; 6 - Booleaan naar decimaal; 7 - Octaal naar decimaal; 8 - Hexadecimaal naar decimaal; 9 - Eenvoudige verandering; 10 - Verandering 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 fout in JSON; 17 - Controleer op fout in XML; 18 - Controleer op fout met reguliere expressie; 19 - Onveranderde waarden negeren; 20 - Onveranderde waarden negeren met hartslag; 21 - JavaScript; 22 - Prometheus-patroon; 23 - Prometheus naar JSON; 24 - CSV naar JSON; 25 - Vervangen; 26 - Controleer op niet-ondersteunde waarde; 27 - XML naar JSON; 28 - Waarde van SNMP walk; 29 - SNMP walk naar JSON. params - (string) Extra parameters gebruikt door voorbewerkingsoptie. Meerdere parameters worden gescheiden door het nieuwe regel (\n) teken.error_handler - (string) Actietype dat wordt gebruikt bij falen van de voorbewerkingstap:0 - Foutbericht wordt ingesteld door Zabbix-server; 1 - Waarde wordt genegeerd; 2 - Aangepaste waarde instellen; 3 - Aangepast foutbericht instellen. error_handler_params - (string) Parameters van de foutafhandelaar. |
| selectValueMap | query | Geef een eigenschap valuemap terug met item-prototype waardekaart. |
| filter | object | Geef alleen resultaten terug die exact overeenkomen met de opgegeven filter. Accepteert een array, waarbij de sleutels eigenschapsnamen zijn, en de waarden ofwel een enkele waarde of een array van waarden om tegenover te stellen. Ondersteunt extra filters: host - technische naam van de host waartoe de item-prototype behoort. |
| limitSelects | integer | Beperkt het aantal records dat wordt teruggegeven door subselecties. Geldt voor de volgende subselecties: selectGraphs - resultaten worden gesorteerd op name;selectTriggers - resultaten worden gesorteerd op description. |
| sortfield | string/array | Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden: itemid, name, key_, delay, type, status. |
| countOutput | boolean | Deze parameters die gemeenschappelijk zijn voor alle get methoden, worden in detail beschreven in de referentie toelichting. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de parameter
countOutputheeft gebruikt.
Voorbeelden
Item Prototype ophalen vanuit een LLD-regel
Haal alle item-prototypes op voor een specifieke LLD-regel-ID.
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "23077",
"type": "0",
"snmp_oid": "",
"hostid": "10079",
"name": "Inkomend netwerkverkeer op 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": "Processorsbelasting (1 min gemiddeld per kern)",
"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": "De processorsbelasting wordt berekend als systeem-CPU-belasting gedeeld door het aantal CPU-kernen.",
"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": []
}
],
"id": 1
}Een afhankelijk item vinden
Vind één afhankelijk item voor een specifiek item-ID.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"filter": {
"type": 18,
"master_itemid": "25545"
},
"limit": "1"
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25547",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Seconden",
"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
}HTTP-agent-itemprototype vinden
Vind een HTTP-agent-itemprototype met de verzoekmethode HEAD voor een specifiek host-ID.
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"filter": {
"type": 19,
"request_method": 3
}
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28257",
"type": "19",
"snmp_oid": "",
"hostid": "10254",
"name": "ontdekt",
"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": "",
"flags": "2",
"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": 1
}Zie ook
Bron
CItemPrototype::get() in ui/include/classes/api/services/CItemPrototype.php.