On this page
item.get
Opis
integer/array item.get(object parameters)
Metoda umożliwia pobieranie pozycji zgodnie z podanymi parametrami.
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody można odebrać w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.
Parametry
(object) Parametry definiujące oczekiwany wynik.
Metoda obsługuje następujące parametry.
| Parameter | Type | Description |
|---|---|---|
| itemids | ID/array | Zwracaj tylko pozycje o podanych identyfikatorach. |
| groupids | ID/array | Zwracaj tylko pozycje należące do hostów z podanych grup. |
| templateids | ID/array | Zwracaj tylko pozycje należące do podanych szablonów. |
| hostids | ID/array | Zwracaj tylko pozycje należące do podanych hostów. |
| proxyids | ID/array | Zwracaj tylko pozycje monitorowane przez podane proxy. |
| interfaceids | ID/array | Zwracaj tylko pozycje korzystające z podanych interfejsów hosta. |
| graphids | ID/array | Zwracaj tylko pozycje używane w podanych wykresach. |
| triggerids | ID/array | Zwracaj tylko pozycje używane w podanych wyzwalaczach. |
| webitems | flag | Uwzględnij web items w wyniku. |
| inherited | boolean | Jeśli ustawione na true, zwracaj tylko pozycje odziedziczone z szablonu. |
| templated | boolean | Jeśli ustawione na true, zwracaj tylko pozycje należące do szablonów. |
| monitored | boolean | Jeśli ustawione na true, zwracaj tylko włączone pozycje należące do monitorowanych hostów. |
| group | string | Zwracaj tylko pozycje należące do grupy o podanej nazwie. |
| host | string | Zwracaj tylko pozycje należące do hosta o podanej nazwie. |
| evaltype | integer | Metoda oceny tagów. Możliwe wartości: 0 - (domyślnie) And/Or; 2 - Or. |
| tags | array | Zwracaj tylko pozycje z podanymi tagami. Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Pusta tablica zwraca wszystkie pozycje. Możliwe wartości operatora: 0 - (domyślnie) Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist. |
| with_triggers | boolean | Jeśli ustawione na true, zwracaj tylko pozycje używane w wyzwalaczach. |
| selectHosts | query | Zwraca właściwość hosts z tablicą hostów, do których należy pozycja. |
| selectInterfaces | query | Zwraca właściwość interfaces z tablicą interfejsów hosta używanych przez pozycję. |
| selectTriggers | query | Zwraca właściwość triggers z wyzwalaczami, w których używana jest pozycja.Obsługuje count. |
| selectGraphs | query | Zwraca właściwość graphs z wykresami, które zawierają pozycję.Obsługuje count. |
| selectDiscoveryData | query | Zwraca właściwość discoveryData z danymi obiektu wykrywania pozycji. Obiekt wykrywania pozycji łączy wykrytą pozycję z prototypem pozycji, z którego została wykryta.Ma następujące właściwości: parent_itemid - (string) identyfikator prototypu pozycji, z którego utworzono pozycję;key_ - (string) klucz prototypu pozycji;status - (int) status wykrywania pozycji:0 - (domyślnie) pozycja została wykryta, 1 - pozycja nie jest już wykrywana; ts_delete - (timestamp) czas, po którym pozycja, która nie jest już wykrywana, zostanie usunięta;ts_disable - (timestamp) czas, po którym pozycja, która nie jest już wykrywana, zostanie wyłączona;disable_source - (int) wskaźnik tego, czy pozycja została wyłączona przez regułę LLD, czy ręcznie:0 - (domyślnie) wyłączona automatycznie, 1 - wyłączona przez regułę LLD. |
| selectDiscoveryRule | query | Zwraca właściwość discoveryRule z regułą LLD, która utworzyła pozycję. |
| selectPreprocessing | query | Zwraca właściwość preprocessing z opcjami wstępnego przetwarzania pozycji. |
| selectTags | query | Zwraca tagi pozycji w właściwości tags. |
| selectValueMap | query | Zwraca właściwość valuemap z mapą wartości pozycji. |
| filter | object | Zwracaj tylko te wyniki, które dokładnie pasują do podanego filtra. Przyjmuje obiekt, w którym klucze są nazwami właściwości, a wartościami jest pojedyncza wartość lub tablica wartości, z którymi ma zostać wykonane dopasowanie. Nie obsługuje właściwości typu danych text.Obsługuje dodatkowe właściwości: host - techniczna nazwa hosta, do którego należy pozycja. |
| limitSelects | integer | Ogranicza liczbę rekordów zwracanych przez podzapytania. Dotyczy następujących podzapytań: selectGraphs - wyniki będą sortowane według name;selectTriggers - wyniki będą sortowane według description. |
| sortfield | string/array | Sortuje wynik według podanych właściwości. Możliwe wartości: itemid, name, key_, delay, history, trends, type, status. |
| countOutput | boolean | Te parametry są opisane w komentarzu referencyjnym. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectItemDiscovery | query | Zwraca właściwość itemDiscovery z obiektem wykrywania pozycji. Obiekt wykrywania pozycji łączy pozycję z prototypem pozycji, z którego została utworzona.To zapytanie jest przestarzałe; zamiast niego użyj selectDiscoveryData. |
Wartości zwracane
(integer/array) Zwraca:
- tablicę obiektów;
- liczbę pobranych obiektów, jeśli użyto parametru
countOutput.
Przykłady
Znajdowanie pozycji według klucza
Pobierz wszystkie pozycje używane w wyzwalaczach dla określonego ID hosta, które zawierają słowo "system.cpu" w kluczu pozycji, i posortuj wyniki według nazwy.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"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": "",
"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",
"name_resolved": "CPU utilization"
},
{
"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": "",
"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",
"name_resolved": "Load average (15m avg)"
},
{
"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": "",
"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",
"name_resolved": "Load average (1m avg)"
},
{
"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": "",
"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",
"name_resolved": "Load average (5m avg)"
},
{
"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": "",
"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",
"name_resolved": "Number of CPUs"
}
],
"id": 1
}Znajdowanie pozycji zależnych według klucza
Pobierz wszystkie pozycje zależne z hosta o ID "10116", które mają słowo "apache" w kluczu.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"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": "",
"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",
"name_resolved": "Days"
},
{
"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": "",
"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",
"name_resolved": "Hours"
}
],
"id": 1
}Znajdź pozycja HTTP agent
Znajdź pozycja HTTP agent z typem treści POST XML dla określonego ID hosta.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 1
}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": "",
"url": "localhost",
"query_fields": [
{
"name": "mode",
"value": "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": "",
"name_resolved": "template item"
}
],
"id": 1
}Pobieranie pozycji z regułami przetwarzania wstępnego
Pobierz wszystkie pozycje i ich reguły przetwarzania wstępnego dla określonego ID hosta.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "extend",
"hostids": "10254"
},
"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.