On this page
item.get
Apraksts
integer/array item.get(object parameters)
Šī metode ļauj izgūt vienumus atbilstoši norādītajiem parametriem.
Šī metode ir pieejama jebkura tipa lietotājiem. Tiesības izsaukt šo metodi var atsaukt lietotāja lomas iestatījumos. Skatiet Lietotāju lomas, lai iegūtu papildu informāciju.
Parametri
(object) Parametri, kas definē vēlamo izvadi.
Metode atbalsta šādus parametrus.
| Parameter | Type | Description |
|---|---|---|
| itemids | ID/array | Atgriezt tikai vienumus ar norādītajiem ID. |
| groupids | ID/array | Atgriezt tikai vienumus, kas pieder hosts no norādītajām grupām. |
| templateids | ID/array | Atgriezt tikai vienumus, kas pieder norādītajām veidnēm. |
| hostids | ID/array | Atgriezt tikai vienumus, kas pieder norādītajiem hosts. |
| proxyids | ID/array | Atgriezt tikai vienumus, ko uzrauga norādītie starpniekserveri. |
| interfaceids | ID/array | Atgriezt tikai vienumus, kas izmanto norādītās host saskarnes. |
| graphids | ID/array | Atgriezt tikai vienumus, kas tiek izmantoti norādītajos grafikos. |
| triggerids | ID/array | Atgriezt tikai vienumus, kas tiek izmantoti norādītajos trigeros. |
| webitems | flag | Iekļaut rezultātā web vienumus. |
| inherited | boolean | Ja iestatīts uz true, atgriezt tikai vienumus, kas mantoti no veidnes. |
| templated | boolean | Ja iestatīts uz true, atgriezt tikai vienumus, kas pieder veidnēm. |
| monitored | boolean | Ja iestatīts uz true, atgriezt tikai iespējotus vienumus, kas pieder uzraudzītiem hosts. |
| group | string | Atgriezt tikai vienumus, kas pieder grupai ar norādīto nosaukumu. |
| host | string | Atgriezt tikai vienumus, kas pieder host ar norādīto nosaukumu. |
| evaltype | integer | Tagu novērtēšanas metode. Iespējamās vērtības: 0 - (noklusējuma) And/Or; 2 - Or. |
| tags | array | Atgriezt tikai vienumus ar norādītajiem tagiem. Formāts: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Tukšs masīvs atgriež visus vienumus. Iespējamās operatora vērtības: 0 - (noklusējuma) Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist. |
| with_triggers | boolean | Ja iestatīts uz true, atgriezt tikai vienumus, kas tiek izmantoti trigeros. |
| selectHosts | query | Atgriezt hosts īpašību ar masīvu no hosts, kuriem vienums pieder. |
| selectInterfaces | query | Atgriezt interfaces īpašību ar masīvu no host saskarnēm, ko izmanto vienums. |
| selectTriggers | query | Atgriezt triggers īpašību ar trigeriem, kuros vienums tiek izmantots.Atbalsta count. |
| selectGraphs | query | Atgriezt graphs īpašību ar grafikiem, kuros ir iekļauts vienums.Atbalsta count. |
| selectDiscoveryData | query | Atgriezt discoveryData īpašību ar vienuma atklāšanas objekta datiem. Vienuma atklāšanas objekts saista atklāto vienumu ar vienuma prototipu, no kura tas tika atklāts.Tam ir šādas īpašības: parent_itemid - (string) vienuma prototipa ID, no kura vienums ir izveidots;key_ - (string) vienuma prototipa atslēga;status - (int) vienuma atklāšanas statuss:0 - (noklusējuma) vienums ir atklāts, 1 - vienums vairs nav atklāts; ts_delete - (timestamp) laiks, kad vienums, kas vairs nav atklāts, tiks dzēsts;ts_disable - (timestamp) laiks, kad vienums, kas vairs nav atklāts, tiks atspējots;disable_source - (int) indikators, vai vienums tika atspējots ar LLD noteikumu vai manuāli:0 - (noklusējuma) atspējots automātiski, 1 - atspējots ar LLD noteikumu. |
| selectDiscoveryRule | query | Atgriezt discoveryRule īpašību ar LLD noteikumu, kas izveidoja vienumu. |
| selectPreprocessing | query | Atgriezt preprocessing īpašību ar vienuma pirmapstrādes opcijām. |
| selectTags | query | Atgriezt vienuma tagus tags īpašībā. |
| selectValueMap | query | Atgriezt valuemap īpašību ar vienuma vērtību kartējumu. |
| filter | object | Atgriezt tikai tos rezultātus, kas precīzi atbilst norādītajam filtram. Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir vai nu viena vērtība, vai vērtību masīvs, ar ko salīdzināt. Neatbalsta text datu tipa īpašības.Atbalsta papildu īpašības: host - tehniskais nosaukums host, kuram pieder vienums. |
| limitSelects | integer | Ierobežo ierakstu skaitu, ko atgriež apakšatlases. Attiecas uz šādām apakšatlasēm: selectGraphs - rezultāti tiks kārtoti pēc name;selectTriggers - rezultāti tiks kārtoti pēc description. |
| sortfield | string/array | Kārtot rezultātu pēc norādītajām īpašībām. Iespējamās vērtības: itemid, name, key_, delay, history, trends, type, status. |
| countOutput | boolean | Šie parametri ir aprakstīti reference commentary. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectItemDiscovery | query | Atgriezt itemDiscovery īpašību ar vienuma atklāšanas objektu. Vienuma atklāšanas objekts saista vienumu ar vienuma prototipu, no kura tas tika izveidots.Šis vaicājums ir novecojis, lūdzu, izmantojiet selectDiscoveryData tā vietā. |
Atgrieztās vērtības
(integer/array) Atgriež vienu no šiem:
- objektu masīvu;
- izgūto objektu skaitu, ja ir izmantots parametrs
countOutput.
Piemēri
Vienumu atrašana pēc atslēgas
Iegūst visus vienumus, kas tiek izmantoti trigeros konkrētam hosta ID un kuru vienuma atslēgā ir vārds "system.cpu", un kārto rezultātus pēc nosaukuma.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"id": 1
}Atbilde:
{
"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
}Atkarīgo vienumu atrašana pēc atslēgas
Iegūstiet visus atkarīgos vienumus no hosta ar ID "10116", kuru atslēgā ir vārds "apache".
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"id": 1
}Atbilde:
{
"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
}Atrast HTTP aģenta vienumu
Atrast HTTP aģenta vienumu ar POST pamatteksta tipu XML konkrētam host ID.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 1
}Atbilde:
{
"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
}Vienumu izgūšana ar priekšapstrādes noteikumiem
Izgūstiet visus vienumus un to priekšapstrādes noteikumus norādītajam hosta ID.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "extend",
"hostids": "10254"
},
"id": 1
}Atbilde:
{
"jsonrpc": "2.0",
"result": {
"itemid": "23865",
"name": "HTTP aģenta JSON piemērs",
"key_": "json",
"preprocessing": [
{
"type": "12",
"params": "$.random",
"error_handler": "1",
"error_handler_params": ""
}
]
},
"id": 1
}Skatiet arī
Avots
CItem::get() failā ui/include/classes/api/services/CItem.php.