Overzicht
De SLA API biedt een set eindpunten om uw Service Level Agreement (SLA)-definities te beheren en SLA-statistieken op te halen om de naleving, beschikbaarheid en performance van uw webservices te garanderen ten opzichte van de bedrijfsvereisten.
Gebruiksvoorbeelden
Gebruik de SLA API om:
- SLA’s en hun configuratie te beheren — SLA’s creëren, bijwerken en verwijderen, en toegang krijgen tot SLA-statistieken (SLA-doelen, uptime commitments en andere).
- Volg de status en performance van uw website of webservices — monitor realtime SLA-status om fouten, trage laadtijden en andere performanceproblemen te identificeren.
Vereisten
Voordat u de SLA API gebruikt, moet u ervoor zorgen dat u beschikt over:
- Uptrends API-inloggegevens
- Inzicht in uw SLA-vereisten en controleregel- configuratie.
SLA API-velden
Wanneer u met de SLA API-eindpunten werkt, bevat het SLA-object verschillende API-velden:
| Veldnaam | Beschrijving |
|---|---|
SlaGuid |
De unieke identifier van de SLA. |
Hash |
De hashwaarde die overeenkomt met de SLA. |
Description |
De naam van de SLA. |
UptimeErrorThreshold |
Het minimum uptimepercentage dat vereist is om fouten te voorkomen. Als de SLA-uptime onder deze ingestelde waarde valt en het SLA-doel niet haalt, wordt er een foutmelding weergegeven in het . |
UptimeWarningThreshold |
Het minimum uptimepercentage dat vereist is om waarschuwingen te voorkomen. Als de uptime van de SLA onder deze waarde valt, maar boven de foutdrempel blijft, worden er waarschuwingen weergegeven in het . |
LoadTimeErrorThreshold |
De maximum laadtijd van de pagina om geen fouten weer te geven. |
OperatorResponseTimeThreshold |
Het tijdsinterval tussen het moment waarop de operator een Uptrends-alertbericht ontvangt en bevestiging van de alert.
|
Gebruik voor geplande downtime of onderhoud de volgende API-velden voor de SLA-uitsluitingsperiode:
| Veldnaam | Beschrijving |
|---|---|
ExclusionPeriodId |
De unieke identifier van de uitsluitingsperiode. |
Hash |
De hash-waarde die overeenkomt met de uitsluitingsperiode. |
Description |
De naam van de uitsluitingsperiode. |
From |
De datum en tijdstempel van wanneer de uitsluitingsperiode begint. |
Until |
De datum en tijdstempel van wanneer de uitsluitingsperiode eindigt. |
SLA API-eindpunten
De SLA API biedt de volgende eindpunten voor het beheren van SLA-definities:
SLA’s beheren
| Methode | Eindpunt | Beschrijving |
|---|---|---|
GET |
/Sla |
Haal een lijst op met alle SLA-definities en hun configuratie. |
POST |
/Sla |
Creëer een nieuwe SLA met de gegeven configuratie. |
GET |
/Sla/{slaGuid} |
Haal een SLA en zijn configuratie op via SLA GUID. |
PUT |
/Sla/{slaGuid} |
Werk alle velden van de SLA-definitie bij. |
PATCH |
/Sla/{slaGuid} |
Werk geselecteerde velden van een SLA-definitie bij. |
DELETE |
/Sla/{slaGuid} |
Verwijder de opgegeven SLA uit uw account. |
SLA uitsluitingsperiodes beheren
| Methode | Eindpunt | Beschrijving |
|---|---|---|
GET |
/Sla/{slaGuid}/ExclusionPeriod |
Haal een lijst op met alle uitsluitingsperiodes voor de gespecificeerde SLA. |
POST |
/Sla/{slaGuid}/ExclusionPeriod |
Creëer een uitsluitingsperiode voor de gespecificeerde SLA met de gegeven configuratie. |
GET |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Haal de uitsluitingsperiode op voor de gespecificeerde SLA. |
PUT |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Werk een uitsluitingsperiode bij voor de gespecificeerde SLA. |
PATCH |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Werk geselecteerde velden van een uitsluitingsperiode bij voor de gespecificeerde SLA. |
DELETE |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Verwijder de gespecificeerde uitsluitingsperiode uit de gespecificeerde SLA. |
Raadpleeg de Uptrends SLA API-documentatie voor gedetailleerde request- en responseformaten en interactieve API-tests.
Probleemoplossing
Deze sectie behandelt veelvoorkomende HTTP-fouten en stappen voor probleemoplossing voor de SLA API.
Veelvoorkomende fouten
Veelvoorkomende HTTP-statuscodes en hun beschrijvingen:
| Statuscode | Beschrijving |
|---|---|
| 200 | OK — request succesvol. |
| 204 | No content — de request is succesvol voltooid en er is geen response geretourneerd. Dit geldt voor DELETE, PUT, PATCH en POST requests. |
| 400 | Bad request — ongeldige requestparameters of ontbrekende verplichte velden. |
| 401 | Unauthorized — ongeldige of ontbrekende authenticatiegegevens. |
| 403 | Forbidden — er zijn een of meer validatiefouten opgetreden. Dit kan verband houden met accountrechten. |
| 404 | Not Found — de gespecificeerde SLA of uitsluitingsperiode bestaat niet. |
| 409 | Conflict — de SLA-naam bestaat al of ander conflict. |
| 500 | Internal Server Error — er is een serverfout opgetreden. |
Algemene handleiding voor probleemoplossing
Zorg ervoor dat u:
- Altijd uw request data valideert voordat u API-calls verstuurt.
- Voor elke operation de juiste HTTP-methoden gebruikt.
Neem voor verdere ondersteuning contact op met ons Support-team.
Gerelateerde artikelen
Raadpleeg de volgende artikelen voor meer informatie:
- Uptrends SLA API-documentatie — een interactieve API-documentatie met gedetailleerde eindpuntspecificaties.
- API changelog — voor de laatste API-updates en meldingen over verouderde API’s.