integer/array item.get(object parameters)
The method allows to retrieve items according to the given parameters.
(object)
Parameters defining the desired output.
The method supports the following parameters.
Parameter | Type | Description |
---|---|---|
itemids | string/array | Return only items with the given IDs. |
groupids | string/array | Return only items that belong to the hosts from the given groups. |
templateids | string/array | Return only items that belong to the given templates. |
hostids | string/array | Return only items that belong to the given hosts. |
proxyids | string/array | Return only items that are monitored by the given proxies. |
interfaceids | string/array | Return only items that use the given host interfaces. |
graphids | string/array | Return only items that are used in the given graphs. |
triggerids | string/array | Return only items that are used in the given triggers. |
applicationids | string/array | Return only items that belong to the given applications. |
webitems | flag | Include web items in the result. |
inherited | boolean | If set to true return only items inherited from a template. |
templated | boolean | If set to true return only items that belong to templates. |
monitored | boolean | If set to true return only enabled items that belong to monitored hosts. |
group | string | Return only items that belong to a group with the given name. |
host | string | Return only items that belong to a host with the given name. |
application | string | Return only items that belong to an application with the given name. |
with_triggers | boolean | If set to true return only items that are used in triggers. |
selectHosts | query | Returns the host that the item belongs to as an array in the hosts property. |
selectInterfaces | query | Returns the host interface used by the item as an array in the interfaces property. |
selectTriggers | query | Return triggers that the item is used in in the triggers property. Supports count . |
selectGraphs | query | Return graphs that contain the item in the graphs property. Supports count . |
selectApplications | query | Return the applications that the item belongs to in the applications property. |
selectDiscoveryRule | query | Return the LLD rule that created the item in the discoveryRule property. |
selectItemDiscovery | query | Return the item discovery object in the itemDiscovery property. The item discovery object links the item to an item prototype from which it was created. It has the following properties: itemdiscoveryid - (string) ID of the item discovery; itemid - (string) ID of the discovered item; parent_itemid - (string) ID of the item prototype from which the item has been created; key_ - (string) key of the item prototype; lastcheck - (timestamp) time when the item was last discovered; ts_delete - (timestamp) time when an item that is no longer discovered will be deleted. |
filter | object | Return only those results that exactly match the given filter. Accepts an array, where the keys are property names, and the values are either a single value or an array of values to match against. Supports additional filters: host - technical name of the host that the item belongs to. |
limitSelects | integer | Limits the number of records returned by subselects. Applies to the following subselects: selectGraphs - results will be sorted by name ; selectTriggers - results will be sorted by description . |
sortfield | string/array | Sort the result by the given properties. Possible values are: itemid , name , key_ , delay , history , trends , type and status . |
countOutput | flag | These parameters being common for all get methods are described in detail in the reference commentary page. |
editable | boolean | |
excludeSearch | flag | |
limit | integer | |
output | query | |
preservekeys | flag | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | flag |
(integer/array)
Returns either:
countOutput
parameter has been used.Retrieve all items from host with ID “10084” that have the word “system” in the key and sort them by name.
Request:
{ "jsonrpc": "2.0", "method": "item.get", "params": { "output": "extend", "hostids": "10084", "search": { "key_": "system" }, "sortfield": "name" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Response:
{ "jsonrpc": "2.0", "result": [ { "itemid": "23298", "type": "0", "snmp_community": "", "snmp_oid": "", "hostid": "10084", "name": "Context switches per second", "key_": "system.cpu.switches", "delay": "60", "history": "7", "trends": "365", "lastvalue": "2552", "lastclock": "1351090998", "prevvalue": "2641", "state": "0", "status": "0", "value_type": "3", "trapper_hosts": "", "units": "sps", "multiplier": "0", "delta": "1", "snmpv3_securityname": "", "snmpv3_securitylevel": "0", "snmpv3_authpassphrase": "", "snmpv3_privpassphrase": "", "formula": "1", "error": "", "lastlogsize": "0", "logtimefmt": "", "templateid": "22680", "valuemapid": "0", "delay_flex": "", "params": "", "ipmi_sensor": "", "data_type": "0", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "mtime": "0", "lastns": "564054253", "flags": "0", "filter": "", "interfaceid": "1", "port": "", "description": "", "inventory_link": "0", "lifetime": "0" }, { "itemid": "23299", "type": "0", "snmp_community": "", "snmp_oid": "", "hostid": "10084", "name": "CPU $2 time", "key_": "system.cpu.util[,idle]", "delay": "60", "history": "7", "trends": "365", "lastvalue": "86.031879", "lastclock": "1351090999", "prevvalue": "85.306944", "state": "0", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "%", "multiplier": "0", "delta": "0", "snmpv3_securityname": "", "snmpv3_securitylevel": "0", "snmpv3_authpassphrase": "", "snmpv3_privpassphrase": "", "formula": "1", "error": "", "lastlogsize": "0", "logtimefmt": "", "templateid": "17354", "valuemapid": "0", "delay_flex": "", "params": "", "ipmi_sensor": "", "data_type": "0", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "mtime": "0", "lastns": "564256864", "flags": "0", "filter": "", "interfaceid": "1", "port": "", "description": "The time the CPU has spent doing nothing.", "inventory_link": "0", "lifetime": "0" }, { "itemid": "23300", "type": "0", "snmp_community": "", "snmp_oid": "", "hostid": "10084", "name": "CPU $2 time", "key_": "system.cpu.util[,interrupt]", "delay": "60", "history": "7", "trends": "365", "lastvalue": "0.008389", "lastclock": "1351091000", "prevvalue": "0.000000", "state": "0", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "%", "multiplier": "0", "delta": "0", "snmpv3_securityname": "", "snmpv3_securitylevel": "0", "snmpv3_authpassphrase": "", "snmpv3_privpassphrase": "", "formula": "1", "error": "", "lastlogsize": "0", "logtimefmt": "", "templateid": "22671", "valuemapid": "0", "delay_flex": "", "params": "", "ipmi_sensor": "", "data_type": "0", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "mtime": "0", "lastns": "564661387", "flags": "0", "filter": "", "interfaceid": "1", "port": "", "description": "The amount of time the CPU has been servicing hardware interrupts.", "inventory_link": "0", "lifetime": "0" } ], "id": 1 }
CItem::get() in frontends/php/include/classes/api/services/CItem.php.