Table of Contents
sla.get
Beschrijving
integer/array sla.get(objectparameters)
De methode maakt het mogelijk om SLA-objecten op te halen volgens de gegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
Parameter | Type | Beschrijving |
|-------------------------|----------------------- ------------------------------|------------------- -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- --| | slaids | tekenreeks/array | Retourneer alleen SLA's met de opgegeven ID's. | | service-id's | tekenreeks/array | Retourneer alleen SLA's die overeenkomen met de specifieke services. | | | | | | selecteerSchema | vraag | Retourneer een eigenschap 'schedule' met SLA-schema's.
Ondersteunt 'count'. | | selecteerUitgeslotenDowntimes | vraag | Retourneer een eigenschap excluded_downtimes met SLA uitgesloten downtimes.
Ondersteunt count. | | selecteerServiceTags | vraag | Retourneer een eigenschap service_tags met SLA-servicetags.
Ondersteunt count. | | | | | | sorteerveld | tekenreeks/array | Sorteer het resultaat op de gegeven eigenschappen.
Mogelijke waarden zijn: slaid, name, period, slo, effective_date, timezone, status en description. | | countOutput | boolean | Deze parameters, die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven in de referentiecommentaar. | | bewerkbaar | boolean | ^ | | uitsluitenZoeken | boolean | ^ | | filter | voorwerp | ^ | | limiet | geheel getal | ^ | | uitvoer | vraag | ^ | | bewaarsleutels | boolean | ^ | | zoeken | voorwerp | ^ | | zoekenByAny | boolean | ^ | | zoekenWildcardsIngeschakeld | booleaans | ^ | | sorteervolgorde | tekenreeks/array | ^ | | startZoeken | booleaans | ^ |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de parameter
countOutputis gebruikt.
Voorbeelden
Ophalen van alle SLA's
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
},
"auth": "85dd04b94cbfad794616eb923be13c71",
"id": 1
}Antwoord:
{
"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
}Bron
CSla:get() in ui/include/classes/api/services/CSla.php.