Überblick
Die SLA API bietet ein Set an Endpunkten, mit denen du deine Definitionen zum Service Level Agreement (SLA, Dienstleistungsvereinbarung) verwalten und SLA-Metriken abrufen kannst, um die Compliance, Verfügbarkeit und Performance deiner Webservices gegenüber Geschäftsanforderungen sicherzustellen.
Einsatzbereiche
Nutze die SLA API, um:
- SLAs und ihre Konfiguration zu verwalten – erstelle, aktualisiere und lösche SLAs und greife auf SLA-Metriken (SLA-Ziele, zugesagte Verfügbarkeit usw.) zu.
- Status und Performance deiner Website oder Webservices zu verfolgen – überwache Echtzeit- SLA-Status, um Fehler, langsame Ladezeiten und andere Performance-Probleme zu identifizieren.
Voraussetzungen
Bevor du die SLA API nutzt, achte darauf, dass du über Folgendes verfügst:
- Uptrends API-Anmeldedaten
- Verständnis über deine SLA-Anforderungen und die Prüfobjektkonfiguration.
Felder der SLA API
Bei der Arbeit mit den Endpunkten der SLA API enthält das SLA-Objekt verschiedene API-Felder:
| Feldname | Beschreibung |
|---|---|
SlaGuid |
Die einzigartige Kennung der SLA. |
Hash |
Der Hash-Wert zur SLA. |
Description |
Der Name der SLA. |
UptimeErrorThreshold |
Der erforderliche Mindestprozentsatz an Verfügbarkeit, um Fehler zu vermeiden. Sollte die SLA-Verfügbarkeit unter diesen gesetzten Wert fallen und das SLA-Ziel nicht erreichen, wird ein Fehler in der angezeigt. |
UptimeWarningThreshold |
Der erforderliche Mindestprozentsatz an Verfügbarkeit, um Warnungen zu vermeiden. Sollte die SLA-Verfügbarkeit unter diesen Wert fallen, aber über der Fehler-Schwelle bleiben, werden Warnungen in der angezeigt. |
LoadTimeErrorThreshold |
Die Höchstladezeit der Seite, bei der keine Fehler angezeigt werden. |
OperatorResponseTimeThreshold |
Die Zeit zwischen dem Eingang einer Uptrends Warnmeldung beim Operator und dem Bestätigen des Alarms.
|
Nutze bei geplanten Ausfallzeiten oder Wartung die folgenden API-Felder zu ausgeschlossenen Zeiträumen der SLA:
| Feldname | Beschreibung |
|---|---|
ExclusionPeriodId |
Die einzigartige Kennung des ausgeschlossenen Zeitraums. |
Hash |
Der Hash-Wert zum ausgeschlossenen Zeitraum. |
Description |
Der Name des ausgeschlossenen Zeitraums. |
From |
Das Datum und Zeitstempel, zu denen der ausgeschlossene Zeitraum beginnt. |
Until |
Das Datum und Zeitstempel, zu denen der ausgeschlossene Zeitraum endet. |
SLA API-Endpunkte
Die SLA API bietet die folgenden Endpunkte zur Verwaltung von SLA-Definitionen:
SLAs verwalten
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET |
/Sla |
Rufe eine Liste aller SLA-Definitionen und ihrer Konfiguration ab. |
POST |
/Sla |
Erstelle anhand der gegebenen Konfiguration eine neue SLA. |
GET |
/Sla/{slaGuid} |
Rufe anhand der SLA GUID eine SLA und ihre Konfiguration ab. |
PUT |
/Sla/{slaGuid} |
Aktualisiere alle Felder der SLA-Definition. |
PATCH |
/Sla/{slaGuid} |
Aktualisiere ausgewählte Felder einer SLA-Definition. |
DELETE |
/Sla/{slaGuid} |
Entferne die angegebene SLA aus deinem Account. |
Ausgeschlossene Zeiträume einer SLA verwalten
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET |
/Sla/{slaGuid}/ExclusionPeriod |
Rufe eine Liste aller ausgeschlossenen Zeiträume der angegebenen SLA ab. |
POST |
/Sla/{slaGuid}/ExclusionPeriod |
Erstelle einen ausgeschlossenen Zeitraum für die angegebene SLA anhand der gegebenen Konfiguration. |
GET |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Rufe den ausgeschlossenen Zeitraum der angegebenen SLA ab. |
PUT |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Aktualisiere einen ausgeschlossenen Zeitraum der angegebenen SLA. |
PATCH |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Aktualisiere ausgewählte Felder eines ausgeschlossenen Zeitraums der angegebenen SLA. |
DELETE |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Entferne den angegebenen ausgeschlossenen Zeitraum der angegebenen SLA. |
Mehr Informationen zu den Abfrage- und Antwortformaten und zu interaktiven API-Tests findest du in der Uptrends SLA API-Dokumentation.
Fehlerbehebung
Dieser Abschnitt behandelt übliche HTTP-Fehler und Schritte zur Fehlerbehebung bei der SLA API.
Übliche Fehler
Übliche HTTP-Statuscodes und ihre Beschreibungen:
| Statuscode | Beschreibung |
|---|---|
| 200 | OK – Abfrage erfolgreich. |
| 204 | Kein Inhalt – die Abfrage wurde erfolgreich gesendet und es wurde keine Antwort zurückgegeben. Dies ist der Fall bei DELETE-, PUT-, PATCH- und POST-Abfragen. |
| 400 | Ungültige Abfrage – ungültige Abfrageparameter oder fehlende erforderliche Felder. |
| 401 | Nicht autorisiert – ungültige oder fehlende Authentifizierungsdaten. |
| 403 | Verboten – es gab einen oder mehrere Validierungsfehler. Das kann in Verbindung mit Accountberechtigungen auftreten. |
| 404 | Nicht gefunden – die angegebene SLA oder der ausgeschlossene Zeitraum existiert nicht. |
| 409 | Konflikt – der SLA-Name existiert bereits oder anderer Widerspruch. |
| 500 | Interner Serverfehler – ein serverseitiger Fehler ist aufgetreten. |
Leitfaden zur allgemeinen Fehlerbehebung
Stelle sicher, dass:
- du immer deine Abfragedaten validierst, bevor du einen API-Aufruf sendest.
- du die entsprechenden HTTP-Methoden für jede Operation verwendest.
Solltest du weitere Hilfe benötigen, wende dich bitte an unser Support-Team.
Verwandte Artikel
Weitere Informationen findest du in den folgenden Artikeln:
- Uptrends SLA API-Dokumentation – eine interaktive API-Dokumentation mit detaillierten Endpunktspezifikationen.
- API-Changelog – mit den neuesten API-Nachrichten und Hinweisen zu nicht fortgeführten Versionen und Endpunkten.