Vue d’ensemble
L’API SLA fournit un ensemble d’endpoints qui vous permettent de gérer les définitions de vos accords de niveau de service (SLA, en anglais Service Level Agreement) et de récupérer vos métriques SLA pour assurer la conformité, la disponibilité et la performance de vos services web d’après les critères établis.
Exemples d’utilisation
L’API SLA vous permet de :
- Gérer les accords de niveau de service et leur configuration : d’une part en créant, en modifiant et en supprimant les accords, et d’autre part en récupérant les métriques SLA (par exemple, objectifs SLA, engagements de temps de disponibilité, etc.)
- Suivre l’état et la performance de votre site web ou de vos services web en surveillant en temps réel le statut SLA pour identifier les erreurs, les lenteurs de chargement et d’autres problèmes de performance.
Prérequis
Pour utiliser l’API SLA, vous avez besoin des éléments suivants :
- Les identifiants de l’API d’Uptrends
- Une bonne connaissance de vos critères SLA et de la configuration de vos moniteurs
Champs de l’API SLA
L’utilisation des endpoints de l’API SLA repose sur l’objet SLA, qui contient différents champs d’API :
| Nom du champ | Description |
|---|---|
SlaGuid |
L’identifiant unique du SLA |
Hash |
La valeur de hachage correspondant au SLA |
Description |
Le nom du SLA |
UptimeErrorThreshold |
Le pourcentage de disponibilité minimum à satisfaire pour éviter les erreurs. Si le pourcentage n’atteint pas cette valeur et échoue à satisfaire l’objectif SLA, une erreur s’affiche dans la . |
UptimeWarningThreshold |
Le pourcentage de disponibilité minimum à satisfaire pour éviter les avertissements. Si le pourcentage n’atteint pas cette valeur sans pour autant dépasser le seuil d’erreur, un avertissement s’affiche dans la . |
LoadTimeErrorThreshold |
Le temps de chargement de page maximum à respecter pour éviter les erreurs |
OperatorResponseTimeThreshold |
L’intervalle de temps entre le moment où l’opérateur reçoit une notification d’alerte Uptrends et le moment où l’alerte est confirmée
|
Pour les périodes d’arrêt ou de maintenance programmées, utilisez les champs d’API correspondant à la période d’exclusion du SLA :
| Nom du champ | Description |
|---|---|
ExclusionPeriodId |
L’identifiant unique de la période d’exclusion |
Hash |
La valeur de hachage correspondant à la période d’exclusion |
Description |
Le nom de la période d’exclusion |
From |
La date et l’heure de début de la période d’exclusion |
Until |
La date et l’heure de fin de la période d’exclusion |
Endpoints de l’API SLA
L’API SLA fournit les endpoints suivants pour gérer les définitions SLA :
Gérer les SLA
| Méthode | Endpoint | Description |
|---|---|---|
GET |
/Sla |
Récupération d’une liste de toutes les définitions SLA et de leur configuration |
POST |
/Sla |
Création d’un nouveau SLA au moyen d’une configuration donnée |
GET |
/Sla/{slaGuid} |
Récupération d’un SLA et de sa configuration par le SLA GUID |
PUT |
/Sla/{slaGuid} |
Actualisation de tous les champs de la définition SLA |
PATCH |
/Sla/{slaGuid} |
Actualisation de certains champs de la définition SLA |
DELETE |
/Sla/{slaGuid} |
Suppression d’un SLA |
Gérer les périodes d’exclusion des SLA
| Méthode | Endpoint | Description |
|---|---|---|
GET |
/Sla/{slaGuid}/ExclusionPeriod |
Récupération d’une liste de toutes les périodes d’exclusion pour le SLA spécifié |
POST |
/Sla/{slaGuid}/ExclusionPeriod |
Création d’une période d’exclusion pour le SLA spécifié au moyen d’une configuration donnée |
GET |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Récupération de la période d’exclusion pour le SLA spécifié |
PUT |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Actualisation d’une période d’exclusion pour le SLA spécifié |
PATCH |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Actualisation de certains champs d’une période d’exclusion pour le SLA spécifié |
DELETE |
/Sla/{slaGuid}/ExclusionPeriod/{exclusionPeriodId} |
Suppression d’une période d’exclusion pour le SLA spécifié |
Pour en savoir plus sur les formats des requêtes et des réponses et la réalisation de tests interactifs, vous pouvez consulter la documentation de l’API SLA d’Uptrends (en anglais).
Dépannage
Vous trouverez ci-dessous les erreurs HTTP les plus courantes et les étapes à suivre pour résoudre les problèmes liés à l’API SLA.
Erreurs courantes
Codes de statut HTTP courants et leurs descriptions :
| Code de statut | Description |
|---|---|
| 200 | OK : requête réussie |
| 204 | Pas de contenu : la requête a été bien exécutée et aucune réponse n’a été envoyée. Ce code s’applique aux requêtes DELETE, PUT, PATCH et POST. |
| 400 | Mauvaise requête : les paramètres de requête sont invalides ou des champs obligatoires sont manquants. |
| 401 | Non autorisé : les identifiants d’authentification sont invalides ou manquants. |
| 403 | Interdit : une ou plusieurs erreurs de validation se sont produites. Ces erreurs peuvent être liées aux autorisations du compte. |
| 404 | Non trouvé : le SLA spécifié ou la période d’exclusion spécifiée n’existe pas. |
| 409 | Conflit : le nom du SLA existe déjà, ou un autre conflit s’est produit. |
| 500 | Erreur de serveur interne : une erreur s’est produite du côté serveur. |
Dépannage général
Pensez à :
- Toujours valider les données de votre requête avant d’envoyer les appels d’API.
- Utiliser des méthodes HTTP appropriées pour chaque opération.
Pour en savoir plus, veuillez contacter notre équipe de support.
Articles liés
Pour en savoir plus, vous pouvez lire les articles suivants :
- Documentation de l’API SLA d’Uptrends : cette documentation interactive vous fournit des spécifications détaillées sur les endpoints (en anglais).
- Journal de modification des API : cette page rassemble les dernières actualités sur l’API et les avis de retrait.