sla.get

Beschreibung

integer/array sla.get(object parameters)

Die Methode ermöglicht es Ihnen, SLA-Objekte anhand der angegebenen Parameter abzurufen.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufruf der Methode kann in den Einstellungen der Benutzerrolle widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

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

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
slaids ID/array Gibt nur SLAs mit den angegebenen IDs zurück.
serviceids ID/array Gibt nur SLAs zurück, die den angegebenen Services entsprechen.
selectSchedule query Gibt eine Eigenschaft schedule mit SLA-Zeitplänen zurück.

Unterstützt count.
selectExcludedDowntimes query Gibt eine Eigenschaft excluded_downtimes mit ausgeschlossenen SLA-Ausfallzeiten zurück.

Unterstützt count.
selectServiceTags query Gibt eine Eigenschaft service_tags mit SLA-Service-Tags zurück.

Unterstützt count.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: slaid, name, period, slo, effective_date, timezone, status, description.
countOutput boolean Diese Parameter sind in der Referenzkommentierung 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 SLAs

Rufen Sie alle Daten zu allen SLAs und ihren Eigenschaften ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "sla.get",
    "params": {
        "output": "extend",
        "selectSchedule": ["period_from", "period_to"],
        "selectExcludedDowntimes": ["name", "period_from", "period_to"],
        "selectServiceTags": ["tag", "operator", "value"],
        "preservekeys": true
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "1": {
            "slaid": "1",
            "name": "Database Uptime",
            "period": "1",
            "slo": "99.9995",
            "effective_date": "1672444800",
            "timezone": "America/Toronto",
            "status": "1",
            "description": "Provide excellent uptime for main SQL database engines.",
            "service_tags": [
                {
                    "tag": "database",
                    "operator": "0",
                    "value": "mysql"
                },
                {
                    "tag": "database",
                    "operator": "0",
                    "value": "postgresql"
                }
            ],
            "schedule": [
                {
                    "period_from": "0",
                    "period_to": "601200"
                }
            ],
            "excluded_downtimes": [
                {
                    "name": "Software version upgrade rollout",
                    "period_from": "1648760400",
                    "period_to": "1648764900"
                }
            ]
        }
    },
    "id": 1
}

Quelle

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