hostgroup.get

Опис

integer/array hostgroup.get(object parameters)

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

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

Параметри

(object) Параметри који дефинишу жељени излаз. Метод подржава следеће параметре.

Parameter Type Опис
graphids ID/array Врати само групе домаћина које садрже домаћине са датим графови.
groupids ID/array Врати само групе домаћина са датим ID-ијевима хост група.
hostids ID/array Врати само групе домаћина које садрже дате домаћине.
maintenanceids ID/array Врати само групе домаћина на које утиче дато одржавање.
triggerids ID/array Врати само групе хостова које садрже домаћине са датим окидачима.
with_graphs flag Врати само групе домаћина које садрже домаћине са графиконима.
with_graph_prototypes flag Врати само групе домаћина које садрже домаћине са прототиповима графикона.
with_hosts flag Врати само групе домаћина које садрже домаћине.
with_httptests flag Врати само групе домаћина које садрже домаћине са веб провере.

Замењује параметар with_monitored_httptests.
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_monitored_httptests flag Врати само групе домаћина које садрже домаћине са омогућеним веб проверама.
with_monitored_hosts flag Врати само групе домаћина које садрже надгледане домаћине.
with_monitored_items flag Врати само групе домаћина које садрже домаћине са омогућеним ставкама.

Замењује параметар with_simple_graph_items.
with_monitored_triggers flag Врати само групе домаћина које садрже домаћине са омогућеним окидачима. Све ставке које се користе у покретачу такође морају бити омогућене.
with_simple_graph_items flag Врати само групе домаћина које садрже домаћине са нумеричким ставкама.
with_triggers flag Врати само групе домаћина које садрже домаћине са окидачима.

Замењује параметар with_monitored_triggers.
selectDiscoveryRules query Врати својство discoveryRules са LLD правилима која су открила групу домаћина.
selectGroupDiscoveries query Врати својство groupDiscoveries са објектима откривања групе домаћина.

Сваки објекат откривања групе домаћина је прототип групе домаћина повезан са откривеном групом домаћина и има следећа својства:
parent_group_prototypeid - (ID) ID прототипа групе домаћина из које је откривена група домаћина;
name - (string) име прототипа групе домаћина;
lastcheck - (timestamp) време када је група домаћина последњи пут откривена;
ts_delete - (timestamp) време када ће група домаћина која више није откривена бити избрисана;
status - (int) Статус откривања групе домаћина:
0 - (подразумевано) група домаћина је откривена,
1 - група домаћина више није откривена.
selectHostPrototypes query Врати hostPrototypes својство са прототиповима домаћина који су открили ову групу домаћина.
selectHosts query Врати својство hosts са домаћинима који припадају групи домаћина.

Подржава count.
limitSelects integerselectHosts Ограничава број записа које враћају подизбори.

Примјењује се на сљедеће подизборе:
selectHosts - резултати ће бити сортирани по host.
sortfield string/array Сортирајте резултат према датим особинама.

Могуће вредности: groupid, name.
countOutput boolean Ови параметри који су заједнички за све методе get су детаљно описани на страници reference commentary.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
monitored_hosts
(deprecated)
flag Овај параметар је застарео, користите with_monitored_hosts уместо тога.
Врати само групе домаћина које садрже надгледане домаћине.
real_hosts
(deprecated)
flag Овај параметар је застарео, користите with_hosts уместо тога.
Врати само групе домаћина које садрже домаћине.

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

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

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

Примери

Преузимање података по имену

Преузми све податке о две групе домаћина под називом „Zabbix servers“ и „Linux servers“.

Request:

{
            "jsonrpc": "2.0",
            "method": "hostgroup.get",
            "params": {
            "output": "extend",
            "filter": {
            "name": [
            "Zabbix servers",
            "Linux servers"
            ]
            }
            },
            "id": 1
       }

Одговор:

{
            "jsonrpc": "2.0",
            "result": [
            {
            "groupid": "2",
            "name": "Linux servers",
            "internal": "0"
            },
            {
            "groupid": "4",
            "name": "Zabbix servers",
            "internal": "0"
            }
            ],
            "id": 1
       }

Такође погледајте

Извор

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