service.get

Beschreibung

integer/array service.get(object parameters)

Diese Methode ermöglicht es, Services entsprechend den angegebenen Parametern abzurufen.

Diese Methode ist für Benutzer aller Typen verfügbar. Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
serviceids ID/array Gibt nur Services mit den angegebenen IDs zurück.
parentids ID/array Gibt nur Services zurück, die mit den angegebenen übergeordneten Services verknüpft sind.
deep_parentids flag Gibt alle direkten und indirekten untergeordneten Services zurück. Wird zusammen mit parentids verwendet.
childids ID/array Gibt nur Services zurück, die mit den angegebenen untergeordneten Services verknüpft sind.
evaltype integer Tag-Auswertungsmethode.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
tags object/array Gibt nur Services mit den angegebenen Tags zurück.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Services zurück.

Mögliche Werte für operator:
0 - (Standard) Enthält;
1 - Entspricht;
2 - Enthält nicht;
3 - Entspricht nicht;
4 - Existiert;
5 - Existiert nicht.
problem_tags object/array Gibt nur Services mit den angegebenen Problem-Tags zurück.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Services zurück.

Mögliche Werte für operator:
0 - (Standard) Enthält;
1 - Entspricht;
2 - Enthält nicht;
3 - Entspricht nicht;
4 - Existiert;
5 - Existiert nicht.
without_problem_tags flag Gibt nur Services ohne Problem-Tags zurück.
slaids ID/array Gibt nur Services zurück, die mit den angegebenen SLA(s) verknüpft sind.
selectChildren query Gibt eine children-Eigenschaft mit den untergeordneten Services zurück.

Unterstützt count.
selectParents query Gibt eine parents-Eigenschaft mit den übergeordneten Services zurück.

Unterstützt count.
selectTags query Gibt eine tags-Eigenschaft mit Service-Tags zurück.

Unterstützt count.
selectProblemEvents query Gibt eine problem_events-Eigenschaft mit einem Array von Problem-Event-Objekten zurück.

Das Problem-Event-Objekt hat die folgenden Eigenschaften:
eventid - (ID) Event-ID;
severity - (string) Aktueller Event-Schweregrad;
name - (string) Name des gelösten Events.

Unterstützt count.
selectProblemTags query Gibt eine problem_tags-Eigenschaft mit Problem-Tags zurück.

Unterstützt count.
selectStatusRules query Gibt eine status_rules-Eigenschaft mit Statusregeln zurück.

Unterstützt count.
selectStatusTimeline object/array Gibt eine status_timeline-Eigenschaft zurück, die Statusänderungen des Service für die angegebenen Zeiträume enthält.

Format [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] - wobei period_from ein Startdatum (einschließlich; Integer-Zeitstempel) und period_to ein Enddatum (ausschließlich; Integer-Zeitstempel) des gewünschten Zeitraums ist.

Gibt ein Array von Einträgen zurück, das eine start_value-Eigenschaft und ein alarms-Array für die Statusänderungen innerhalb der angegebenen Zeiträume enthält.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: serviceid, name, status, sortorder, created_at.
countOutput boolean Diese Parameter sind in der Referenzbeschreibung beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder Folgendes zurück:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Abrufen aller Services

Rufen Sie alle Daten zu allen Services und ihren Abhängigkeiten ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "service.get",
    "params": {
        "output": "extend",
        "selectChildren": "extend",
        "selectParents": ["serviceid", "name"]
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "serviceid": "1",
            "name": "Zabbix cluster",
            "status": "-1",
            "algorithm": "2",
            "sortorder": "0",
            "weight": "0",
            "propagation_rule": "0",
            "propagation_value": "0",
            "description": "",
            "uuid": "8d77bd91b62347e4b79382912eb5df95",
            "created_at": "1761742392",
            "readonly": false,
            "parents": [],
            "children": [
                {
                    "serviceid": "2",
                    "name": "Zabbix server node 1",
                    "status": "-1",
                    "algorithm": "2",
                    "sortorder": "0",
                    "weight": "0",
                    "propagation_rule": "0",
                    "propagation_value": "0",
                    "description": "",
                    "uuid": "195911d26d7f4e218d6217079bcd5929",
                    "created_at": "1761742623",
                    "readonly": false
                },
                {
                    "serviceid": "3",
                    "name": "Zabbix server node 2",
                    "status": "-1",
                    "algorithm": "2",
                    "sortorder": "0",
                    "weight": "0",
                    "propagation_rule": "0",
                    "propagation_value": "0",
                    "description": "",
                    "uuid": "9fc659a30fe244f690dff25fc2a9db5c",
                    "created_at": "1761742654",
                    "readonly": false
                }
            ]
        },
        {
            "serviceid": "2",
            "name": "Zabbix server node 1",
            "status": "-1",
            "algorithm": "2",
            "sortorder": "0",
            "weight": "0",
            "propagation_rule": "0",
            "propagation_value": "0",
            "description": "",
            "uuid": "195911d26d7f4e218d6217079bcd5929",
            "created_at": "1761742623",
            "readonly": false,
            "parents": [
                {
                    "serviceid": "1",
                    "name": "Zabbix cluster"
                }
            ],
            "children": []
        },
        {
            "serviceid": "3",
            "name": "Zabbix server node 2",
            "status": "-1",
            "algorithm": "2",
            "sortorder": "0",
            "weight": "0",
            "propagation_rule": "0",
            "propagation_value": "0",
            "description": "",
            "uuid": "9fc659a30fe244f690dff25fc2a9db5c",
            "created_at": "1761742654",
            "readonly": false,
            "parents": [
                {
                    "serviceid": "1",
                    "name": "Zabbix cluster"
                }
            ],
            "children": []
        }
    ],
    "id": 1
}

Quelle

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