Vous consultez la documentation Apigee Edge.
Consulter la documentation d'Apigee X en savoir plus
Utilisez l'API /metrics/events pour obtenir tous les événements d'une organisation pendant 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 de paramètre de requête from et to acceptent 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>: un entier<unit>: unité de temps des, sec, second, m, min, minute, h, hr, hour, d, day
- Une date au format ISO sous la forme suivante :
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 au cours des 12 dernières heures:
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 options curl utilisées dans cet exemple, consultez la page Utiliser curl.
Cette API accepte les paramètres de requête facultatifs suivants:
| Nom | Description | Par défaut |
|---|---|---|
from
|
Début de l'intervalle de temps pendant lequel les alertes doivent être récupérées. La valeur par défaut correspond à l'heure actuelle moins une heure. Pour savoir comment définir ce paramètre, consultez la description ci-dessus. | -1h |
to
|
Fin de l'intervalle de temps pendant lequel les alertes doivent être récupérées. La valeur par défaut est l'heure actuelle. Pour savoir comment définir ce paramètre, consultez la description ci-dessus. | maintenant |
alertId
|
Filtrer 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
|
Permet de filtrer les événements en fonction de l'environnement spécifié. | Tous les environnements |
name
|
Permet de filtrer les événements en fonction du nom d'alerte spécifié. | Tous les noms d'alerte |
region
|
Filtrez les événements en fonction de la région spécifiée. | Toutes les régions |
type
|
Filtrer les événements en fonction du type spécifié: alert.
|
Tous les types |