Überblick
Public Status Pages, die öffentlichen Statusseiten, bieten einen Überblick über die Verfügbarkeit und Performance deiner Website. Sie können einem weiteren Publikum, wie etwa Kunden oder Interessenvertretern, zugänglich gemacht werden, um Echtzeitinformationen zur Verfügbarkeit zu präsentieren und die Transparenz in Bezug auf deine Webservices zu fördern.
Einsatzbereiche
Nutze die PublicStatusPage API um:
- Public Status Pages zu verwalten – erstelle, aktualisiere und lösche Public Status Pages
- Einstellungen von Public Status Pages anzupassen – personalisiere die Seite über die Einstellungen von Titel, Hintergrundfarbe, Sortieren usw.
- mehrere Public Status Pages gleichzeitig anzuzeigen – zeige Echtzeitstatus und Details für mehrere Seiten gleichzeitig an, um diese leichter zu analysieren, verfolgen und zu berichten.
Voraussetzungen
Bevor du die Public Status Page API nutzt, achte darauf, dass du über Folgendes verfügst:
Felder der Public Status Page API
Die PublicStatusPage API enthält verschiedene API-Felder:
| Feldname | Beschreibung |
|---|---|
PublicDashboardGuid |
Die einzigartige Kennung der Public Status Page. |
Name |
Der Name der Public Status Page. |
IsPublished |
Lautet true, wenn die Public Status Page veröffentlicht und für die Öffentlichkeit verfügbar ist. Andernfalls lautet es false. |
PresetPeriodType |
Der Zeitraum, für den die Daten angezeigt werden. Verfügbare Filteroptionen:
|
CustomizationInfo |
Enthält unterschiedliche Felder, um deine Public Status Page zu ändern und zu personalisieren. Weitere Informationen findest du unten im Abschnitt CustomizationInfo.
|
SlaGuid |
Die einzigartige Kennung der SLA. Wenn die veröffentlichte Statusseite Daten enthält, die auf einer SLA beruhen, wird die ausgewählte SLA verwendet. |
MonitorGuids |
Die einzigartige Kennung der Prüfobjekte, die auf der Public Status Page gezeigt wird. |
MonitorGroupGuids |
Die einzigartige Kennung der Prüfobjektgruppen, die auf der Public Status Page gezeigt werden. |
Die Felder für CustomizationInfo
Über die CustomizationInfo-Felder kannst du die
Anzeigeeinstellungen deiner Public Status Page anpassen:
| CustomizationInfo-Feldname | Beschreibung |
|---|---|
MainColor |
Der Hexadezimal-Farbwert, der für das Motiv der Public Status Page verwendet wurde. |
BackgroundColor |
Der Hexadezimal-Farbwert, der für den Hintergrund der Public Status Page verwendet wurde. |
TextColor |
Der Hexadezimal-Farbwert, der für den Text der Public Status Page verwendet wurde. |
SortColumnsNewToOld |
Lautet true, wenn die Spalten von “neu” nach “alt” sortiert werden. Andernfalls lautet es false. |
SortRowsProperty |
Definiert, wie Zeilen sortiert werden. Mögliche Werte sind Alphabetical (nach Prüfobjektname) oder ByStatus (nach Prüfobjektstatus, Fehler zuerst). |
CommentTitle |
Der angezeigte Titel im Banner der Public Status Page. |
CommentText |
Die im Banner angezeigte Nachricht, um Nutzer über den aktuellen Status oder Probleme der Public Status Page zu informieren. |
AutoRefresh |
Lautet true, wenn die Public Status Page sich automatisch aktualisiert und Daten abruft. Andernfalls lautet es false. |
Endpunkte der Public Status Page API
Die Public Status Page API stellt die folgenden Endpunkte zur Verwaltung deiner Prüfobjekte bereit:
Prüfobjekte verwalten
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET |
/PublicStatusPage |
Rufe eine Liste aller Public Status Pages in deinem Account ab. |
POST |
/PublicStatusPage |
Erstelle eine neue Public Status Page anhand der eingegebenen Konfiguration. |
GET |
/PublicStatusPage/{publicStatusPageGuid} |
Rufe die angegebene Public Status Page und ihre Konfiguration ab. |
PATCH |
/PublicStatusPage/{publicStatusPageGuid} |
Aktualisiere die ausgewählten Felder der Public Status Page-Definition. |
PUT |
/PublicStatusPage/{publicStatusPageGuid} |
Aktualisieren alle Felder der Public Status Page-Definition. |
DELETE |
/PublicStatusPage/{publicStatusPageGuid} |
Entferne die angegebene Public Status Page aus deinem Account. |
Mehr Informationen zu den Abfrage- und Antwortformaten und zu interaktiven API-Tests findest du in der Uptrends Public Status Page API-Dokumentation.
Fehlerbehebung
Dieser Abschnitt behandelt übliche HTTP-Fehler und Schritte zur Fehlerbehebung bei der Public Status Page 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 – Erlaubnis verweigert. |
| 404 | Nicht gefunden – die angegebene GUID existiert nicht. |
| 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.
Weitere Artikel
Weitere Informationen findest du in den folgenden Artikeln:
- Uptrends Public Status Page 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.