Documentation
Table of Contents
item.get
Opis
integer/array item.get(object parameters)
Metoda umożliwia pobranie pozycji zgodnie z określonymi parametrami.
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do jej wywołania mogą zostać cofnięte w ustawieniach ról użytkownika. Zobacz Role użytkowników , aby uzyskać więcej informacji.
Parametry
(object) Parametry określające pożądany wynik.
Metoda obsługuje następujące parametry.
| Parametr | Typ | Opis |
|---|---|---|
| itemids | string/array | Zwróć tylko pozycje o określonych identyfikatorach. |
| groupids | string/array | Zwróć tylko pozycje należące do hostów z określonych grup. |
| templateids | string/array | Zwróć tylko pozycje należące do określonych szablonów. |
| hostids | string/array | Zwróć tylko pozycje należące do określonych hostów. |
| proxyids | string/array | Zwróć tylko pozycje monitorowane przez określone proxy. |
| interfaceids | string/array | Zwróć tylko pozycje korzystające z określonych interfejsów hosta. |
| graphids | string/array | Zwróć tylko pozycje używane w określonych wykresach. |
| triggerids | string/array | Zwróć tylko pozycje używane w określonych wyzwalaczach. |
| webitems | flag | Uwzględnij pozycje scenariuszy WWW w wyniku. |
| inherited | boolean | Jeśli ustawione na true, zwróć tylko pozycje odziedziczone z szablonu. |
| templated | boolean | Jeśli ustawione na true, zwróć tylko pozycje należące do szablonów. |
| monitored | boolean | Jeśli ustawione na true, zwróć tylko włączone pozycje należące do monitorowanych hostów. |
| group | string | Zwróć tylko pozycje należące do grupy o określonej nazwie. |
| host | string | Zwróć tylko pozycje należące do hosta o określonej nazwie. |
| evaltype | integer | Reguły wyszukiwania tagów. Możliwe wartości: 0 - (domyślnie) I/LUB; 2 - LUB. |
| tags | array of objects | Zwróć tylko pozycje z określonymi znacznikami. Dokładne dopasowanie według tagu i wyszukiwanie z uwzględnieniem wielkości liter lub bez zależnie od wartości operatora. Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Pusta tablica zwraca wszystkie pozycje. Możliwe typy operatorów: 0 - (domyślnie) Zawiera; 1 - Jest równy; 2 - Nie zawiera; 3 - Nie jest równy 4 - Istnieje; 5 - Nie istnieje. |
| with_triggers | boolean | Jeśli ustawione na true, zwróć tylko pozycje używane w wyzwalaczach. |
| selectHosts | query | Zwróć właściwość hosts z tablicą hostów, do których należy pozycja. |
| selectInterfaces | query | Zwróć właściwość interfaces z tablicą interfejsów hosta używanych przez pozycję. |
| selectTriggers | query | Zwróć właściwość triggers z wyzwalaczami, w których używana jest pozycja. Obsługuje count. |
| selectGraphs | query | Zwróć właściwość graphs z wykresami zawierającymi pozycję. Obsługuje count. |
| selectDiscoveryRule | query | Zwróć właściwość discoveryRule z regułą LLD, która utworzyła pozycję. |
| selectItemDiscovery | query | Zwróć właściwość itemDiscovery z obiektem wykrywania pozycji. Obiekt wykrywania pozycji łączy pozycję z prototypem pozycji, z którego została utworzona.Ma następujące właściwości: itemdiscoveryid - (string) ID wykrywania pozycji;itemid - (string) ID wykrytej pozycji;parent_itemid - (string) ID prototypu pozycji, z którego pozycja została utworzona;key_ - (string) klucz prototypu pozycji;lastcheck - (timestamp) czas ostatniego wykrycia pozycji;ts_delete - (timestamp) czas, kiedy pozycja, która nie jest już wykrywana, zostanie usunięta. |
| selectPreprocessing | query | Zwróć właściwość preprocessing z opcjami przetwarzania wstępnego pozycji. Ma następujące właściwości: type - (string) Typ opcji przetwarzania:1 - Własny mnożnik; 2 - Przytnij z prawej; 3 - Przytnij z lewej; 4 - Przytnij; 5 - Wyrażenie regularne; 6 - Boolowski na dziesiętny; 7 - Ósemkowy na dziesiętny; 8 - Szesnastkowy na dziesiętny; 9 - Prosta zmiana; 10 - Zmiana na sekundę; 11 - XML XPath; 12 - Ścieżka JSONPath; 13 - W przedziale; 14 - Pasuje wyrażenie regularne; 15 - Brak dopasowania wyrażenia regularnego; 16 - Sprawdź błąd w JSON; 17 - Sprawdź błąd w XML; 18 - Sprawdź błąd przy użyciu wyrażenia regularnego; 19 - Odrzuć niezmienione; 20 - Odrzuć niezmienione z heartbeat; 21 - JavaScript; 22 - Wzorzec Prometheus; 23 - Prometheus na JSON; 24 - CSV na JSON; 25 - Zastąp; 26 - Sprawdź wartości nieobsługiwane; 27 - XML na JSON. params - (string) Dodatkowe parametry używane przez opcję przetwarzania wstępnego. Wiele parametrów jest oddzielonych znakiem LF (\n).error_handler - (string) Typ działania używanego w przypadku niepowodzenia kroku przetwarzania:0 - Komunikat o błędzie jest ustawiony przez serwer Zabbix; 1 - Odrzucić wartość; 2 - Ustaw wartość niestandardową; 3 - Ustaw niestandardowy komunikat o błędzie. error_handler_params - (string) Parametry obsługi błędów. |
| selectTags | query | Zwróć znaczniki pozycji w właściwości tags. |
| selectValueMap | query | Zwróć właściwość valuemap z mapą wartości pozycji. |
| filter | object | Zwróć tylko te wyniki, które dokładnie pasują do podanego filtru. Akceptuje tablicę, gdzie klucze są nazwami właściwości, a wartości to pojedyncza wartość lub tablica wartości do dopasowania. Obsługuje dodatkowe filtry: host - nazwa techniczna hosta, do którego należy pozycja. |
| limitSelects | integer | Ogranicza liczbę rekordów zwracanych przez podzapytanie. Dotyczy następujących podzapytań: selectGraphs - wyniki będą sortowane według name;selectTriggers - wyniki będą sortowane według description. |
| sortfield | string/array | Sortuj wyniki według określonych właściwości. Możliwe wartości to: itemid, name, key_, delay, history, trends, type i status. |
| countOutput | boolean | Te parametry, będące wspólne dla wszystkich metod get, są szczegółowo opisane na stronie komentarza referencyjnego. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Zwracane wartości
(integer/array) Zwraca jedną z opcji:
- tablicę obiektów;
- liczbę pobranych obiektów, jeśli parametr
countOutputzostał wykorzystany.
Przykłady
Znajdowanie pozycji według klucza
Pobierz wszystkie pozycje używane w wyzwalaczach określonego identyfikatora hosta, które zawierają słowo "system.cpu" w kluczu pozycji i posortuj wyniki według nazwy.
Zapytanie:
{ "jsonrpc": "2.0", "method": "item.get", "params": { "output": "extend", "hostids": "10084", "with_triggers": true, "search": { "key_": "system.cpu" }, "sortfield": "name" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Odpowiedź:
{ "jsonrpc": "2.0", "result": [ { "itemid": "42269", "type": "18", "snmp_oid": "", "hostid": "10084", "name": "CPU utilization", "key_": "system.cpu.util", "delay": "0", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "%", "logtimefmt": "", "templateid": "42267", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "0", "description": "CPU utilization in %.", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "42264", "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", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0" }, { "itemid": "42259", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (15m avg)", "key_": "system.cpu.load[all,avg15]", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42219", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "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", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0" }, { "itemid": "42249", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (1m avg)", "key_": "system.cpu.load[all,avg1]", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42209", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "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", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0" }, { "itemid": "42257", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (5m avg)", "key_": "system.cpu.load[all,avg5]", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42217", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "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", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0" }, { "itemid": "42260", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Number of CPUs", "key_": "system.cpu.num", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "3", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42220", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "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", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0" } ], "id": 1 }Znajdowanie zależnych pozycji według klucza
Pobierz wszystkie zależne pozycje z hosta o identyfikatorze "10116", które zawierają słowo "apache" w kluczu.
Zapytanie:
{ "jsonrpc": "2.0", "method": "item.get", "params": { "output": "extend", "hostids": "10116", "search": { "key_": "apache" }, "filter": { "type": 18 } }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Odpowiedź:
{ "jsonrpc": "2.0", "result": [ { "itemid": "25550", "type": "18", "snmp_oid": "", "hostid": "10116", "name": "Days", "key_": "apache.status.uptime.days", "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": "", "flags": "0", "interfaceid": "0", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "25545", "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", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0" }, { "itemid": "25555", "type": "18", "snmp_oid": "", "hostid": "10116", "name": "Hours", "key_": "apache.status.uptime.hours", "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": "", "flags": "0", "interfaceid": "0", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "25545", "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", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0" } ], "id": 1 }Znajdź pozycję agenta HTTP
Znajdź pozycję agenta HTTP o typie żądania POST jako dane XML dla określonego identyfikatora hosta.
Zapytanie:
{ "jsonrpc": "2.0", "method": "item.get", "params": { "hostids": "10255", "filter": { "type": 19, "post_type": 3 } }, "id": 3, "auth": "d678e0b85688ce578ff061bd29a20d3b" }Odpowiedź:
{ "jsonrpc": "2.0", "result": [ { "itemid": "28252", "type": "19", "snmp_oid": "", "hostid": "10255", "name": "template item", "key_": "ti", "delay": "30s", "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": "", "flags": "0", "interfaceid": "0", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "0", "timeout": "3s", "url": "localhost", "query_fields": [ { "mode": "xml" } ], "posts": "<body>\r\n<![CDATA[{$MACRO}<foo></bar>]]>\r\n</body>", "status_codes": "200", "follow_redirects": "0", "post_type": "3", "http_proxy": "", "headers": [], "retrieve_mode": "1", "request_method": "3", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "", "prevvalue": "" } ], "id": 3 }Pobieranie pozycji z zasadami przetwarzania wstępnego
Pobierz wszystkie pozycje i ich zasady przetwarzania wstępnego dla określonego identyfikatora hosta.
Zapytanie:
{ "jsonrpc": "2.0", "method": "item.get", "params": { "output": ["itemid", "name", "key_"], "selectPreprocessing": "extend", "hostids": "10254" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Odpowiedź:
{ "jsonrpc": "2.0", "result": { "itemid": "23865", "name": "HTTP agent example JSON", "key_": "json", "preprocessing": [ { "type": "12", "params": "$.random", "error_handler": "1", "error_handler_params": "" } ] }, "id": 1 }Zobacz także
Źródło
CItem::get() w ui/include/classes/api/services/CItem.php.