sla.get

Opis

integer/array sla.get(object parameters)

Ta metoda pozwala na pobieranie obiektów SLA zgodnie z podanymi parametrami.

Metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody można wyłączyć w ustawieniach ról użytkowników. Zobacz Role użytkowników aby uzyskać więcej informacji.

Parametry

(object) Parametry definiujące pożądany wynik.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
slaids string/array Zwróć tylko SLA o podanych identyfikatorach.
serviceids string/array Zwróć tylko SLA odpowiadające określonym usługom.
selectSchedule query Zwróć właściwość schedule z harmonogramami SLA.

Obsługuje count.
selectExcludedDowntimes query Zwróć właściwość excluded_downtimes z wyłączonymi czasami przestoju SLA.

Obsługuje count.
selectServiceTags query Zwróć właściwość service_tags z znacznikami usługi SLA.

Obsługuje count.
sortfield string/array Posortuj wynik według określonych właściwości.

Dopuszczalne wartości to: slaid, name, period, slo, effective_date, timezone, status i description.
countOutput boolean Parametry te, będąc wspólne dla wszystkich metod get, są szczegółowo opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie wszystkich SLA

Pobierz wszystkie dane dotyczące wszystkich SLA i ich właściwości.

Zapytanie:

{
    "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
    },
    "auth": "85dd04b94cbfad794616eb923be13c71",
    "id": 1
}

Odpowiedź:

{
    "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
}

Źródło

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