item.get

Опис

integer/array item.get(object parameters)

Метода омогућава преузимање ставки према датим параметрима.

Ова метода је доступна корисницима било ког типа. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Улога корисника за више информација.

Параметри

(објекат) Параметри који дефинишу жељени излаз.

Метода подржава следеће параметре.

Параметар Тип Опис
itemids ID/array Врати само ставке са датим ID-ијевима.
groupids ID/array Врати само ставке које припадају домаћинима из датих група.
templateids ID/array Врати само ставке које припадају датим шаблонима.
hostids ID/array Врати само ставке које припадају датим домаћинима.
proxyids ID/array Врати само ставке које прате дати проксији.
interfaceids ID/array Врати само ставке које користе дате интерфејсе домаћина.
graphids ID/array Врати само ставке које се користе у датим графовима.
triggerids ID/array Врати само ставке које се користе у датим окидачима.
webitems flag Укључи веб ставке у резултат.
inherited boolean Ако је подешено на true, врати само ставке наслеђене из шаблона.
templated boolean Ако је подешено на true, врати само ставке које припадају шаблонима.
monitored boolean Ако је подешено на true, врати само омогућене ставке које припадају праћеним домаћинима.
group string Врати само ставке које припадају групи са датим именом.
host string Врати само ставке које припадају домаћину са датим именом.
evaltype integer Правила за претрагу ознака.

Могуће вредности:
0 - (подразумевано) И/Или;
2 - Или.
tags array Врати само ставке са датим ознакама. Тачно подударање по ознаци и претрага са осетљивошћу на велика и мала слова или без осетљивости на велика и мала слова по вредности ознаке у зависности од вредности оператора.
Формат: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Празан низ враћа све ставке.

Могући типови оператора:
0 - (подразумевано) Слично;
1 - Једнако;
2 - Није слично;
3 - Није једнако;
4 - Постоји;
5 - Не постоји.
with_triggers boolean Ако је подешено на true, враћа само ставке које се користе у тригерима.
selectHosts query Враћа својство hosts са низом хостова којима ставка припада.
selectInterfaces query Врати својство interfaces са низом домаћина интерфејса које користи ставка.
selectTriggers query Врати својство triggers са окидачима у којима се ставка користи.

Подржава count.
selectGraphs query Врати својство graphs са графиконима који садрже ставку.

Подржава count.
selectDiscoveryData query Врати својство discoveryData са подацима објекта за откривање ставке. Објекат за откривање ставке повезује откривену ставку са прототипом ставке из које је откривена.

Има следећа својства:
itemdiscoveryid - (string) ID откривања ставке;
parent_itemid - (string) ИД прототипа ставке из којег је ставка креирана;
key_ - (string) кључ прототипа ставке;
lastcheck - (timestamp) време када је ставка последњи пут откривена;
status - (int) статус откривања ставке:
0 - (подразумевано) ставка је откривена,
1 - ставка више није откривена;
ts_delete - (timestamp) време када ће ставка која више није откривена бити обрисана;
ts_disable - (timestamp) време када ће ставка која више није откривена бити онемогућена;
disable_source - (int) индикатор да ли је ставка онемогућена LLD правилом или ручно:
0 - (подразумевано) аутоматски онемогућено,
1 - онемогућено LLD правилом.
selectDiscoveryRule query Врати својство discoveryRule са LLD правилом које је креирало ставку.
selectDiscoveryRulePrototype query Врати својство discoveryRulePrototype са родитељским прототипом LLD правила који је креирао ставку.
selectItemDiscovery query Врати својство itemDiscovery са објектом за откривање ставке. Објекат за откривање ставке повезује ставку са прототипом ставке од ког је креирана.

Овај упит је застарео, уместо њега користите selectDiscoveryData.
selectPreprocessing query Врати својство preprocessing са опцијама за претходну обраду ставке.
selectTags query Врати ознаке ставке у својству tags.
selectValueMap query Врати својство valuemap са мапом вредности ставке.
филтер објекат Враћа само оне резултате који се тачно подударају са датим филтером.

Прихвата објекат, где су кључеви имена својстава, а вредности су или једна вредност или низ вредности за упоређивање.

Не подржава својства text тип података.

Подржава додатна својства:
host - технички назив домаћина којем ставка припада.
limitSelects integer Ограничава број записа које враћају подизбори.

Односи се на следеће подизборе:
selectGraphs - резултати ће бити сортирани по name;
selectTriggers - резултати ће бити сортирани по description.
sortfield string/array Сортира резултат по датим својствима.

Могуће вредности: itemid, name, key_, delay, history, trends, type, status.
countOutput boolean Ови параметри су описани у референтном коментару.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Повратне вредности

(integer/array) Враћа било:

  • низ објеката;
  • број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Проналажење ставки по кључу

Преузми све ставке које се користе у окидачима за одређени ID домаћина који имају реч "system.cpu" у кључу ставке и сортирај резултате по имену.

Захтев:

{
            "jsonrpc": "2.0",
            "method": "item.get",
            "params": {
            "output": "extend",
            "hostids": "10084",
            "with_triggers": true,
            "search": {
            "key_": "system.cpu"
            },
            "sortfield": "name"
            },
            "id": 1
       }

Одговор:

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

Проналажење зависних ставки по кључу

Преузми све зависне ставке са домаћина са ID-ијем "10116" које имају реч "apache" у кључу.

Захтев:

{
            "jsonrpc": "2.0",
            "method": "item.get",
            "params": {
            "output": "extend",
            "hostids": "10116",
            "search": {
            "key_": "apache"
            },
            "filter": {
            "type": 18
            }
            },
            "id": 1
       }

Одговор:

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

Пронађите ставку HTTP агента

Пронађите ставку HTTP агента са KSML типом тела поста за одређени ID домаћина.

Захтев:

{
            "jsonrpc": "2.0",
            "method": "item.get",
            "params": {
            "hostids": "10255",
            "filter": {
            "type": 19,
            "post_type": 3
            }
            },
            "id": 1
       }

Одговор:

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

Преузимање ставки са правилима за претходну обраду

Преузми све ставке и њихова правила за претходну обраду за одређени ID домаћина.

Request:

{
            "jsonrpc": "2.0",
            "method": "item.get",
            "params": {
            "output": ["itemid", "name", "key_"],
            "selectPreprocessing": "extend",
            "hostids": "10254"},
            "id": 1
       }

Одговор:

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

Види такође

Извор

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