Vous consultez la documentation Apigee Edge.
Accédez à la
documentation**Apigee X**. info
Utilisez l'API /metrics/events pour obtenir tous les événements d'une organisation pour un intervalle de temps spécifié. La liste des événements inclut toutes les alertes détectées par Edge.
Par défaut, l'API renvoie tous les événements de l'heure précédente.
Utilisez les paramètres de requête from et to pour spécifier une durée différente.
Les valeurs des paramètres de requête from et to sont compatibles avec les formats suivants :
now(heure locale actuelle)-<value><unit>spécifie une heure dans le passé (notez le trait d'union au début) :<value>: entier<unit>: unité de temps parmis, sec, second, m, min, minute, h, hr, hour, d, day
- Date au format ISO :
yyyy-mm-ddThh:mm:ssZyyyy-mm-ddThh:mm:ss+00:00
Exemple :
now- -
1h -10min2019-05-13T14:04:00+00:00
Seul le paramètre de requête org est obligatoire. L'appel d'API suivant renvoie tous les événements de l'organisation myorg pour les 12 heures précédentes :
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ "https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&from=-12h&to=now"
Définissez $ACCESS_TOKEN sur votre jeton d'accès OAuth 2.0, comme décrit dans la section Obtenir un jeton d'accès OAuth 2.0. Pour en savoir plus sur les curl options utilisées dans cet exemple, consultez la page Utiliser curl.
Cette API est compatible avec les paramètres de requête facultatifs suivants :
| Nom | Description | Par défaut |
|---|---|---|
from
|
Début de l'intervalle de temps pour lequel les alertes doivent être récupérées. La valeur par défaut correspond à l'heure actuelle moins une heure. Pour en savoir plus sur la définition de ce paramètre, consultez la description ci-dessus. | -1h |
to
|
Fin de l'intervalle de temps pour lequel les alertes doivent être récupérées. La valeur par défaut correspond à l'heure actuelle. Pour en savoir plus sur la définition de ce paramètre, consultez la description ci-dessus. | maintenant |
alertId
|
Filtre les résultats de l'historique des alertes en fonction de l'ID de définition d'alerte spécifié. | Tous les ID d'alerte |
env
|
Filtre les événements en fonction de l'environnement spécifié. | Tous les environnements |
name
|
Filtre les événements en fonction du nom d'alerte spécifié. | Tous les noms d'alerte |
region
|
Filtre les événements en fonction de la région spécifiée. | Toutes les régions |
type
|
Filtre les événements en fonction du type spécifié : alert.
|
Tous les types |