[comment]: # ({65bbffce-65bbffce})
# host.get
[comment]: # ({/65bbffce-65bbffce})
[comment]: # ({54619a1f-93035b19})
### Описание
`integer/array host.get(параметры объекта)`
Метод позволяет получить хосты по заданным параметрам.
::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::
[comment]: # ({/54619a1f-93035b19})
[comment]: # ({71515b4e-77a8fabb})
### Параметры
`(object)` Параметры, определяющие требуемый результат.
Метод поддерживает следующие параметры.
|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|--|
|groupids|ID/array|Возвращать только узлы сети, которые принадлежат указанным группам.|
|dserviceids|ID/array|Возвращать только узлы сети, связанные с указанными обнаруженными службами.|
|graphids|ID/array|Возвращать только узлы сети, у которых есть указанные графики.|
|hostids|ID/array|Возвращать только узлы сети с указанными ID узлов сети.|
|httptestids|ID/array|Возвращать только узлы сети, у которых есть указанные веб-проверки.|
|interfaceids|ID/array|Возвращать только узлы сети, которые используют указанные интерфейсы.|
|itemids|ID/array|Возвращать только узлы сети, у которых есть указанные элементы данных.|
|maintenanceids|ID/array|Возвращать только узлы сети, на которые влияют указанные обслуживания.|
|monitored\_hosts|flag|Возвращать только контролируемые узлы сети.|
|proxyids|ID/array|Возвращать только узлы сети, которые контролируются указанными прокси.|
|proxy_groupids|ID/array|Возвращать только узлы сети, которые контролируются указанными группами прокси.|
|templated\_hosts|flag|Возвращать и узлы сети, и шаблоны.|
|templateids|ID/array|Возвращать только узлы сети, связанные с указанными шаблонами.|
|triggerids|ID/array|Возвращать только узлы сети, у которых есть указанные триггеры.|
|with\_items|flag|Возвращать только узлы сети, у которых есть элементы данных.
Переопределяет параметры `with_monitored_items` и `with_simple_graph_items`.|
|with\_item\_prototypes|flag|Возвращать только узлы сети, у которых есть прототипы элементов данных.
Переопределяет параметр `with_simple_graph_item_prototypes`.|
|with\_simple\_graph\_item\_prototypes|flag|Возвращать только узлы сети, у которых есть прототипы элементов данных, включенные для создания и имеющие числовой тип информации.|
|with\_graphs|flag|Возвращать только узлы сети, у которых есть графики.|
|with\_graph\_prototypes|flag|Возвращать только узлы сети, у которых есть прототипы графиков.|
|with\_httptests|flag|Возвращать только узлы сети, у которых есть веб-проверки.
Переопределяет параметр `with_monitored_httptests`.|
|with\_monitored\_httptests|flag|Возвращать только узлы сети, у которых есть включенные веб-проверки.|
|with\_monitored\_items|flag|Возвращать только узлы сети, у которых есть включенные элементы данных.
Переопределяет параметр `with_simple_graph_items`.|
|with\_monitored\_triggers|flag|Возвращать только узлы сети, у которых есть включенные триггеры. Все элементы данных, используемые в триггере, также должны быть включены.|
|with\_simple\_graph\_items|flag|Возвращать только узлы сети, у которых есть элементы данных с числовым типом информации.|
|with\_triggers|flag|Возвращать только узлы сети, у которых есть триггеры.
Переопределяет параметр `with_monitored_triggers`.|
|withProblemsSuppressed|boolean|Если установлено в `true`, возвращать только узлы сети с подавленными проблемами.|
|evaltype|integer|Метод [оценки тегов](/manual/web_interface/frontend_sections/data_collection/hosts#using-filter).
Возможные значения:
0 - *(по умолчанию)* And/Or;
2 - Or.|
|severities|integer/array|Возвращать узлы сети, у которых есть только проблемы с указанными уровнями серьезности. Применяется только если объект проблемы является триггером.|
|tags|object/array|Возвращать только узлы сети с указанными тегами.
Формат: `[{"tag": "", "value": "", "operator": ""}, ...]`.
Пустой массив возвращает все узлы сети.
Возможные значения [оператора](/manual/web_interface/frontend_sections/data_collection/hosts#using-filter):
0 - *(по умолчанию)* Содержит;
1 - Равно;
2 - Не содержит;
3 - Не равно;
4 - Существует;
5 - Не существует.|
|inheritedTags|boolean|Возвращать узлы сети, у которых указанные `tags` также присутствуют во всех связанных шаблонах.
Возможные значения:
`true` - связанные шаблоны также должны иметь указанные `tags`;
`false` - *(по умолчанию)* теги связанных шаблонов игнорируются.|
|selectDiscoveryData|query|Возвращать свойство `discoveryData` с данными объекта обнаружения узла сети. Объект обнаружения узла сети связывает обнаруженный узел сети с прототипом узла сети, из которого он был обнаружен.
Он имеет следующие свойства:
`host` - `(string)` ID узла сети;
`parent_hostid` - `(string)` ID прототипа узла сети, из которого был создан узел сети;
`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) с правилом низкоуровневого обнаружения, которое создало узел сети (из прототипа узла сети в мониторинге VMware).|
|selectDiscoveryRules|query|Возвращать свойство [`discoveryRules`](/manual/api/reference/discoveryrule/object) с правилами LLD узла сети.
Поддерживает `count`.|
|selectGraphs|query|Возвращать свойство [`graphs`](/manual/api/reference/graph/object) с графиками узла сети.
Поддерживает `count`.|
|selectHostGroups|query|Возвращать свойство [`hostgroups`](/manual/api/reference/hostgroup/object) с данными групп узлов сети, к которым принадлежит узел сети.|
|selectHttpTests|query|Возвращать свойство [`httpTests`](/manual/api/reference/httptest/object) с веб-сценариями узла сети.
Поддерживает `count`.|
|selectInterfaces|query|Возвращать свойство [`interfaces`](/manual/api/reference/hostinterface/object) с интерфейсами узла сети.
Поддерживает `count`.|
|selectInventory|query|Возвращать свойство [`inventory`](/manual/api/reference/host/object#host-inventory) с данными инвентаря узла сети.|
|selectItems|query|Возвращать свойство [`items`](/manual/api/reference/item/object) с элементами данных узла сети.
Поддерживает `count`.|
|selectMacros|query|Возвращать свойство [`macros`](/manual/api/reference/usermacro/object) с макросами узла сети.|
|selectParentTemplates|query|Возвращать свойство `parentTemplates` с [шаблонами](/manual/api/reference/template/object), к которым привязан узел сети.
Помимо полей объекта Template, содержит `link_type` - `(integer)` способ привязки шаблона к узлу сети.
Возможные значения:
0 - *(по умолчанию)* привязан вручную;
1 - автоматически привязан LLD.
Поддерживает `count`.|
|selectDashboards|query|Возвращать свойство [`dashboards`](/manual/api/reference/templatedashboard/object).
Поддерживает `count`.|
|selectTags|query|Возвращать свойство [`tags`](/manual/api/reference/host/object#host-tag) с тегами узла сети.|
|selectInheritedTags|query|Возвращать свойство [`inheritedTags`](/manual/api/reference/host/object#host-tag) с тегами, которые присутствуют во всех шаблонах, связанных с узлом сети.|
|selectTriggers|query|Возвращать свойство [`triggers`](/manual/api/reference/trigger/object) с триггерами узла сети.
Поддерживает `count`.|
|selectValueMaps|query|Возвращать свойство [`valuemaps`](/manual/api/reference/valuemap/object) с картами значений узла сети.|
|filter|object|Возвращать только те результаты, которые точно соответствуют указанному фильтру.
Принимает объект, где ключи - это имена свойств, а значения - либо одно значение, либо массив значений для сопоставления.
Не поддерживает свойства с [типом данных](/manual/api/reference_commentary#data-types) `text`.
Поддерживает дополнительные свойства: свойства [интерфейса узла сети](/manual/api/reference/hostinterface/object#host-interface-object).|
|limitSelects|integer|Ограничивает количество записей, возвращаемых подвыборами.
Применяется к следующим подвыборам:
`selectParentTemplates` - результаты будут отсортированы по `host`;
`selectInterfaces`;
`selectItems` - сортировка по `name`;
`selectDiscoveryRules` - сортировка по `name`;
`selectTriggers` - сортировка по `description`;
`selectGraphs` - сортировка по `name`;
`selectDashboards` - сортировка по `name`.|
|search|object|Возвращать результаты, соответствующие указанному шаблону (без учета регистра).
Принимает объект, где ключи - это имена свойств, а значения - строки для поиска. Если дополнительные параметры не указаны, будет выполнен поиск `LIKE "%…%"`.
Поддерживает только свойства с [типом данных](/manual/api/reference_commentary#data-types) `string` и `text`.
Поддерживает дополнительные свойства: свойства [интерфейса узла сети](/manual/api/reference/hostinterface/object#host-interface-object).|
|searchInventory|object|Возвращать узлы сети, у которых данные инвентаря соответствуют указанному шаблону (без учета регистра).
Принимает объект, где ключи - это имена свойств, а значения - строки для поиска. Если дополнительные параметры не указаны, будет выполнен поиск `LIKE "%…%"`.
Поддерживает только свойства с [типом данных](/manual/api/reference_commentary#data-types) `string` и `text`.|
|sortfield|string/array|Сортировать результат по указанным свойствам.
Возможные значения: `hostid`, `host`, `name`, `status`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
|selectDiscoveries|query|Возвращать свойство [`discoveries`](/manual/api/reference/discoveryrule/object) с правилами низкоуровневого обнаружения узла сети.
Поддерживает `count`.
Этот запрос **устарел**, вместо него используйте `selectDiscoveryRules`.|
|selectHostDiscovery|query|Возвращать свойство `hostDiscovery` с данными объекта обнаружения узла сети.
Этот запрос **устарел**, вместо него используйте `selectDiscoveryData`.|
[comment]: # ({/71515b4e-77a8fabb})
[comment]: # ({7223bab1-7223bab1})
### Возвращаемые значения
`(integer/array)` Возвращает либо:
- массив объектов;
- количество извлеченных объектов, если параметр `countOutput`
был использован.
[comment]: # ({/7223bab1-7223bab1})
[comment]: # ({b41637d2-b41637d2})
### Примеры
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({bdf49605-c6ea3cce})
#### Получение данных по имени
Получите все данные о двух узлах сети с именами "Zabbix server" и "Linux
server".
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"filter": {
"host": [
"Zabbix server",
"Linux server"
]
}
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10160",
"proxyid": "0",
"host": "Zabbix server",
"status": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Zabbix server",
"flags": "0",
"description": "Сервер мониторинга Zabbix.",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"proxy_groupid": "0",
"monitored_by": "0",
"inventory_mode": "1",
"active_available": "1",
"assigned_proxyid": "0"
},
{
"hostid": "10167",
"proxyid": "0",
"host": "Linux server",
"status": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Linux server",
"flags": "0",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"proxy_groupid": "0",
"monitored_by": "0",
"inventory_mode": "1",
"active_available": "1",
"assigned_proxyid": "0"
}
],
"id": 1
}
```
[comment]: # ({/bdf49605-c6ea3cce})
[comment]: # ({8d87c206-9078aff7})
#### Получение групп узлов сети
Получите группы узлов сети, членом которых является узел сети "Zabbix server".
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectHostGroups": "extend",
"filter": {
"host": [
"Zabbix server"
]
}
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"hostgroups": [
{
"groupid": "2",
"name": "Linux servers",
"flags": "0",
"uuid": "dc579cd7a1a34222933f24f52a68bcd8"
},
{
"groupid": "4",
"name": "Zabbix servers",
"flags": "0",
"uuid": "6f6799aa69e844b4b3918f779f2abf08"
}
]
}
],
"id": 1
}
```
[comment]: # ({/8d87c206-9078aff7})
[comment]: # ({3f6d4bdf-59c8a46a})
#### Получение связанных шаблонов
Получите идентификаторы и имена шаблонов, связанных с узлом сети "10084".
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectParentTemplates": [
"templateid",
"name"
],
"hostids": "10084"
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"parentTemplates": [
{
"name": "Linux",
"templateid": "10001"
},
{
"name": "Zabbix Server",
"templateid": "10047"
}
]
}
],
"id": 1
}
```
[comment]: # ({/3f6d4bdf-59c8a46a})
[comment]: # ({9a8b8f9f-942e31bf})
#### Получение узлов сети по шаблону
Получите узлы сети, к которым привязан шаблон "10001" (*Linux by Zabbix agent*).
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid", "name"],
"templateids": "10001"
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Zabbix server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}
```
[comment]: # ({/9a8b8f9f-942e31bf})
[comment]: # ({63a1e5ba-8be1d99c})
#### Поиск по инвентарным данным узла сети
Получение узлов сети, которые содержат "Linux" в поле "OS" инвентаря узла сети.
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"host"
],
"selectInventory": [
"os"
],
"searchInventory": {
"os": "Linux"
}
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"host": "Zabbix server",
"inventory": {
"os": "Linux Ubuntu"
}
},
{
"hostid": "10107",
"host": "Linux server",
"inventory": {
"os": "Linux Mint"
}
}
],
"id": 1
}
```
[comment]: # ({/63a1e5ba-8be1d99c})
[comment]: # ({cfc9b43a-b4e37e5e})
#### Поиск по тегам узла сети
Получить узлы сети, у которых тег "host-name" равен "linux-server".
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "host-name",
"value": "linux-server",
"operator": 1
}
]
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"tags": [
{
"tag": "host-name",
"value": "linux-server",
"automatic": "0"
},
{
"tag": "os",
"value": "rhel-7",
"automatic": "0"
}
]
}
],
"id": 1
}
```
Получить узлы сети, у которых эти теги заданы не только на уровне узла сети, но и в связанных родительских шаблонах.
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"tags": [
{
"tag": "os",
"value": "rhel-7",
"operator": 1
}
],
"inheritedTags": true
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10623",
"name": "PC room 1"
},
{
"hostid": "10601",
"name": "Office"
}
],
"id": 1
}
```
Получить узлы сети, исключая те, у которых есть тег "component".
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "component",
"value": "",
"operator": 5
}
]
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"tags": [
{
"tag": "class",
"value": "os",
"automatic": "0"
},
{
"tag": "target",
"value": "linux",
"automatic": "0"
}
]
},
{
"hostid": "10629",
"tags": [
{
"tag": "class",
"value": "application",
"automatic": "0"
},
{
"tag": "target",
"value": "browser",
"automatic": "0"
}
]
}
],
"id": 1
}
```
[comment]: # ({/cfc9b43a-b4e37e5e})
[comment]: # ({c6c128e0-9ebae84e})
#### Поиск узла сети с тегами и тегами шаблона
Получение узла сети с тегами и всеми тегами, связанными с родительскими шаблонами.
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"hostids": 10502,
"selectTags": ["tag", "value"],
"selectInheritedTags": ["tag", "value"]
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10502",
"name": "Desktop",
"tags": [
{
"tag": "host-name",
"value": "linux-server"
},
{
"tag": "os",
"value": "rhel-7"
}
],
"inheritedTags": [
{
"tag": "class",
"value": "os"
},
{
"tag": "target",
"value": "linux"
},
{
"tag": "os",
"value": "rhel-7"
}
]
}
],
"id": 1
}
```
[comment]: # ({/c6c128e0-9ebae84e})
[comment]: # ({ee33fbef-219d4ee1})
#### Поиск хостов по серьезности проблемы
Получить хосты, у которых есть проблемы «катастрофа» (Disaster).
Запрос:
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": 5
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10160",
"name": "Zabbix server"
}
],
"id": 1
}
```
Получить хосты с проблемами уровня "средние" (Average) и "высокие" (High).
Запрос:
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": [3, 4]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "20170",
"name": "Database"
},
{
"hostid": "20183",
"name": "workstation"
}
],
"id": 1
}
```
[comment]: # ({/ee33fbef-219d4ee1})
[comment]: # ({2a837857-56ff1999})
#### Получение элементов данных узла сети
Получите элементы данных для узла сети "Zabbix server". Запрос ограничен свойствами элемента данных `itemid`, `name` и `status`. Из-за большого размера ответа в примере показана только часть элементов данных.
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectItems": ["itemid","name","status"],
"filter": {
"host": [
"Zabbix server"
]
}
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"items": [
{
"itemid": "42227",
"name": "Host name of Zabbix agent running",
"status": "0"
},
{
"itemid": "42237",
"name": "Zabbix agent ping",
"status": "0"
},
{
"itemid": "42250",
"name": "Version of Zabbix agent running",
"status": "0"
},
{
"itemid": "42251",
"name": "Maximum number of open file descriptors",
"status": "0"
},
{
"itemid": "42252",
"name": "Maximum number of processes",
"status": "0"
},
{
"itemid": "69869",
"name": "Interface enp0s3: Inbound packets discarded",
"status": "0"
},
{
"itemid": "69870",
"name": "Interface enp0s3: Inbound packets with errors",
"status": "0"
},
{
"itemid": "69871",
"name": "Interface enp0s3: Bits received",
"status": "0"
},
{
"itemid": "69872",
"name": "Interface enp0s3: Outbound packets discarded",
"status": "0"
},
{
"itemid": "69873",
"name": "Interface enp0s3: Outbound packets with errors",
"status": "0"
},
{
"itemid": "69874",
"name": "Interface enp0s3: Bits sent",
"status": "0"
},
{
"itemid": "42253",
"name": "Number of processes",
"status": "0"
},
{
"itemid": "42254",
"name": "Number of running processes",
"status": "0"
},
{
"itemid": "42255",
"name": "System boot time",
"status": "0"
}
]
}
],
"id": 1
}
```
[comment]: # ({/2a837857-56ff1999})
[comment]: # ({fd8058f7-06c7fe93})
### См. также
- [Группа узлов сети](/manual/api/reference/hostgroup/object#host-group)
- [Шаблон](/manual/api/reference/template/object#template)
- [Пользовательский макрос](/manual/api/reference/usermacro/object#hosttemplate-level-macro)
- [Интерфейс узла сети](/manual/api/reference/hostinterface/object#host-interface)
- [Прокси](/manual/api/reference/proxy/object#proxy)
- [Группа прокси](/manual/api/reference/proxygroup/object#proxy-group)
[comment]: # ({/fd8058f7-06c7fe93})
[comment]: # ({55c08f7a-55c08f7a})
### Источник
CHost::get() в *ui/include/classes/api/services/CHost.php*.
[comment]: # ({/55c08f7a-55c08f7a})