This is a translation of the original English documentation page. Help us make it better.

sla.get

Beschrijving

integer/array sla.get(object parameters)

Deze methode maakt het mogelijk om SLA-objecten op te halen aan de hand van de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode op te roepen kan worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
slaids string/array Geef alleen SLA's terug met de opgegeven IDs.
serviceids string/array Geef alleen SLA's terug die overeenkomen met specifieke services.
selectSchedule query Geef een schedule eigenschap terug met SLA-schema's.

Ondersteunt count.
selectExcludedDowntimes query Geef een excluded_downtimes eigenschap terug met uitgesloten downtimes van SLA's.

Ondersteunt count.
selectServiceTags query Geef een service_tags eigenschap terug met servicetags van SLA's.

Ondersteunt count.
sortfield string/array Sorteer het resultaat op de opgegeven eigenschappen.

Mogelijke waarden: slaid, name, period, slo, effective_date, timezone, status, description.
countOutput boolean Deze parameters zijn gemeenschappelijk voor alle get-methoden en worden in detail beschreven in de referentie-opmerkingen.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Retourwaarden

(integer/array) Geeft ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de parameter countOutput is gebruikt.

Voorbeelden

Alle SLA's ophalen

Haal alle gegevens op over alle SLA's en hun eigenschappen.

Verzoek:

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

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "1": {
                   "slaid": "1",
                   "name": "Database Uptime",
                   "period": "1",
                   "slo": "99.9995",
                   "effective_date": "1672444800",
                   "timezone": "America/Toronto",
                   "status": "1",
                   "description": "Bied uitstekende uptime voor belangrijke 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": "Uitrol van softwareversie-upgrade",
                           "period_from": "1648760400",
                           "period_to": "1648764900"
                       }
                   ]
               }
           },
           "id": 1
       }

Bron

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