hostgroup.get

Apraksts

integer/array hostgroup.get(object parameters)

Metode ļauj izgūt hostu grupas atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā Lietotāju lomas.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
graphids ID/array Atgriezt tikai tās hostu grupas, kurās ir hosti ar norādītajiem grafikiem.
groupids ID/array Atgriezt tikai hostu grupas ar norādītajiem hostu grupu ID.
hostids ID/array Atgriezt tikai tās hostu grupas, kurās ir norādītie hosti.
maintenanceids ID/array Atgriezt tikai tās hostu grupas, kuras ietekmē norādītās apkopes.
triggerids ID/array Atgriezt tikai tās hostu grupas, kurās ir hosti ar norādītajiem trigeriem.
with_graphs boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar grafikiem.
with_graph_prototypes boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar grafiku prototipiem.
with_hosts boolean Atgriezt tikai tās hostu grupas, kurās ir hosti.
with_httptests boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar tīmekļa pārbaudēm.

Aizstāj parametru with_monitored_httptests.
with_items boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar vienumiem.

Aizstāj parametrus with_monitored_items un with_simple_graph_items.
with_item_prototypes boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar vienumu prototipiem.

Aizstāj parametru with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar vienumu prototipiem, kas ir iespējoti izveidei un kuriem ir skaitlisks informācijas tips.
with_monitored_httptests boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar iespējotām tīmekļa pārbaudēm.
with_monitored_hosts boolean Atgriezt tikai tās hostu grupas, kurās ir uzraudzīti hosti.
with_monitored_items boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar iespējotiem vienumiem.

Aizstāj parametru with_simple_graph_items.
with_monitored_triggers boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar iespējotiem trigeriem. Visiem trigerī izmantotajiem vienumiem arī jābūt iespējotiem.
with_simple_graph_items boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar skaitliskiem vienumiem.
with_triggers boolean Atgriezt tikai tās hostu grupas, kurās ir hosti ar trigeriem.

Aizstāj parametru with_monitored_triggers.
selectDiscoveryRules query Atgriezt īpašību discoveryRules ar LLD kārtulām, kas atklāja hostu grupu.
selectDiscoveryData query Atgriezt īpašību discoveryData ar hostu grupu atklāšanas objektiem.

Katrs hostu grupas atklāšanas objekts ir hostu grupas prototips, kas saistīts ar atklāto hostu grupu, un tam ir šādas īpašības:
parent_group_prototypeid - (ID) hostu grupas prototipa ID, no kura tika atklāta hostu grupa;
name - (string) hostu grupas prototipa nosaukums;
ts_delete - (timestamp) laiks, kad hostu grupa, kas vairs netiek atklāta, tiks dzēsta;
status - (int) hostu grupas atklāšanas statuss:
0 - (noklusējums) hostu grupa ir atklāta,
1 - hostu grupa vairs netiek atklāta.
selectHostPrototypes query Atgriezt īpašību hostPrototypes ar hostu prototipiem, kas atklāja šo hostu grupu.
selectHosts query Atgriezt īpašību hosts ar hostiem, kas pieder hostu grupai.

Atbalsta count.
limitSelects integer Ierobežo apakšatlases vaicājumu atgriezto ierakstu skaitu.

Attiecas uz šādiem apakšatlases vaicājumiem:
selectHosts - rezultāti tiks kārtoti pēc host.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: groupid, name.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroupDiscoveries query Atgriezt īpašību groupDiscoveries ar hostu grupu atklāšanas objektiem.

Katrs hostu grupas atklāšanas objekts ir hostu grupas prototips, kas saistīts ar atklāto hostu grupu.

Šis vaicājums ir novecojis, lūdzu, tā vietā izmantojiet selectDiscoveryData.

Atgrieztās vērtības

(integer/array) Atgriež:

  • objektu masīvu
  • iegūto objektu skaitu, ja ir izmantots parametrs countOutput

Piemēri

Datu izgūšana pēc nosaukuma

Izgūstiet visus datus par divām hostu grupām ar nosaukumiem "Zabbix servers" un "Linux servers".

Pieprasījums:

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

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "2",
            "name": "Linux servers",
            "flags": "0",
            "uuid": "dc579cd7a1a34222933f24f52a68bcd8"
        },
        {
            "groupid": "4",
            "name": "Zabbix servers",
            "flags": "0",
            "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
    ],
    "id": 1
}

Skatiet arī

Avots

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