[comment]: # ({58fbd3bc-58fbd3bc})
# item.get
[comment]: # ({/58fbd3bc-58fbd3bc})
[comment]: # ({14484745-673edf7f})
### Описание
`integer/array item.get(параметры объекта)`
Этот метод позволяет получать элементы данных в соответствии с заданными
параметрами.
::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::
[comment]: # ({/14484745-673edf7f})
[comment]: # ({641397fb-cc946363})
### Параметры
`(object)` Параметры, определяющие требуемый результат.
Метод поддерживает следующие параметры.
|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|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|Метод [оценки тегов](/manual/web_interface/frontend_sections/data_collection/hosts/items#using-filter).
Возможные значения:
0 - *(по умолчанию)* And/Or;
2 - Or.|
|tags|array|Возвращать только элементы данных с указанными тегами.
Формат: `[{"tag": "", "value": "", "operator": ""}, ...]`.
Пустой массив возвращает все элементы данных.
Возможные значения [оператора](/manual/web_interface/frontend_sections/data_collection/hosts/items#using-filter):
0 - *(по умолчанию)* Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.|
|with\_triggers|boolean|Если установлено значение `true`, возвращать только элементы данных, которые используются в триггерах.|
|selectHosts|query|Возвращать свойство [`hosts`](/manual/api/reference/host/object) с массивом узлов сети, к которым принадлежит элемент данных.|
|selectInterfaces|query|Возвращать свойство [`interfaces`](/manual/api/reference/hostinterface/object) с массивом интерфейсов узлов сети, используемых элементом данных.|
|selectTriggers|query|Возвращать свойство [`triggers`](/manual/api/reference/trigger/object) с триггерами, в которых используется элемент данных.
Поддерживает `count`.|
|selectGraphs|query|Возвращать свойство [`graphs`](/manual/api/reference/graph/object) с графиками, которые содержат элемент данных.
Поддерживает `count`.|
|selectDiscoveryData|query|Возвращать свойство `discoveryData` с данными объекта обнаружения элемента данных. Объект обнаружения элемента данных связывает обнаруженный элемент данных с прототипом элемента данных, из которого он был обнаружен.
Он имеет следующие свойства:
`parent_itemid` - `(string)` ID прототипа элемента данных, из которого был создан элемент данных;
`key_` - `(string)` ключ прототипа элемента данных;
`status` - `(int)` статус обнаружения элемента данных:
0 - *(по умолчанию)* элемент данных обнаружен,
1 - элемент данных больше не обнаружен;
`ts_delete` - `(timestamp)` время, когда элемент данных, который больше не обнаружен, будет удален;
`ts_disable` - `(timestamp)` время, когда элемент данных, который больше не обнаружен, будет отключен;
`disable_source` - `(int)` признак того, был ли элемент данных отключен правилом LLD или вручную:
0 - *(по умолчанию)* отключен автоматически,
1 - отключен правилом LLD.|
|selectDiscoveryRule|query|Возвращать свойство [`discoveryRule`](/manual/api/reference/discoveryrule/object) с правилом LLD, которое создало элемент данных.|
|selectPreprocessing|query|Возвращать свойство [`preprocessing`](/manual/api/reference/item/object#item-preprocessing) с параметрами предварительной обработки элемента данных.|
|selectTags|query|Возвращать теги элемента данных в свойстве [`tags`](/manual/api/reference/item/object#item-tag).|
|selectValueMap|query|Возвращать свойство [`valuemap`](/manual/api/reference/valuemap/object) с картой значений элемента данных.|
|filter|object|Возвращать только те результаты, которые точно соответствуют заданному фильтру.
Принимает объект, где ключи — это имена свойств, а значения — либо одно значение, либо массив значений, с которыми выполняется сравнение.
Не поддерживает свойства с [типом данных](/manual/api/reference_commentary#data-types) `text`.
Поддерживает дополнительные свойства:
`host` - техническое имя узла сети, к которому принадлежит элемент данных.|
|limitSelects|integer|Ограничивает количество записей, возвращаемых подвыборами.
Применяется к следующим подвыборам:
`selectGraphs` - результаты будут отсортированы по `name`;
`selectTriggers` - результаты будут отсортированы по `description`.|
|sortfield|string/array|Сортировать результат по указанным свойствам.
Возможные значения: `itemid`, `name`, `key_`, `delay`, `history`, `trends`, `type`, `status`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
|selectItemDiscovery|query|Возвращать свойство `itemDiscovery` с объектом обнаружения элемента данных. Объект обнаружения элемента данных связывает элемент данных с прототипом элемента данных, из которого он был создан.
Этот запрос **устарел**, вместо него используйте `selectDiscoveryData`.
[comment]: # ({/641397fb-cc946363})
[comment]: # ({7223bab1-7223bab1})
### Возвращаемые значения
`(целое число/массив)` Возвращает либо:
- · массив объектов;
- · количество извлеченных объектов, если использовался параметр `countOutput`.
[comment]: # ({/7223bab1-7223bab1})
[comment]: # ({b41637d2-b41637d2})
### Примеры
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({1a09225b-59b84d93})
#### Поиск элементов данных по ключу
Получить все элементы данных, используемые в триггерах для указанного ID узла сети, у которых в ключе элемента данных есть слово "system.cpu", и отсортировать результаты по имени.
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"id": 1
}
```
Ответ:
```json
{
"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
}
```
[comment]: # ({/1a09225b-59b84d93})
[comment]: # ({a6ae1426-674b0856})
#### Поиск зависимых элементов данных по ключу
Получите все зависимые элементы данных с узла сети с ID "10116", у которых в ключе есть слово "apache".
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"id": 1
}
```
Ответ:
```json
{
"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
}
```
[comment]: # ({/a6ae1426-674b0856})
[comment]: # ({256e2a05-94dc4b21})
#### Найти элемент данных HTTP agent
Найти элемент данных HTTP agent с типом тела POST XML для указанного ID узла сети.
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 1
}
```
Ответ:
```json
{
"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": "\r\n]]>\r\n",
"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
}
```
[comment]: # ({/256e2a05-94dc4b21})
[comment]: # ({6697de6d-f4b01bbe})
#### Получение элементов данных с правилами предварительной обработки
Получите все элементы данных и их правила предварительной обработки для указанного ID узла сети.
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "extend",
"hostids": "10254"
},
"id": 1
}
```
Ответ:
```json
{
"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
}
```
[comment]: # ({/6697de6d-f4b01bbe})
[comment]: # ({8d9fbd3b-d3276b35})
### См. также
- [Правило обнаружения](/manual/api/reference/discoveryrule/object#discovery-rule)
- [График](/manual/api/reference/graph/object#graph)
- [Узел сети](/manual/api/reference/host/object#host)
- [Интерфейс узла сети](/manual/api/reference/hostinterface/object#host-interface)
- [Триггер](/manual/api/reference/trigger/object#trigger)
[comment]: # ({/8d9fbd3b-d3276b35})
[comment]: # ({a6ef1d0f-a6ef1d0f})
### Источник
CItem::get() в *ui/include/classes/api/services/CItem.php*.
[comment]: # ({/a6ef1d0f-a6ef1d0f})