Vous consultez la documentation d'Apigee Edge.
Consultez la
documentation Apigee X. en savoir plus
Chemin de base de la plate-forme API:https://api.enterprise.apigee.com/v1/o/{org_name}
Chemin d'accès aux ressources de l'API:/environments/{env_name}/stats/{dimension_name}
Description:utilisez la méthode GET pour récupérer les métriques d'une dimension.
| Verbe: | GET |
| Authentification: | Authentification de base |
| Types de support: |
application/json
|
Présentation:Un rapport est généré à l'aide d'une requête GET sur la ressource d'API
/stats, accompagnée de:
- Paramètre URI facultatif qui définit la dimension du rapport. Apigee définit un ensemble de dimensions et pré-agrège un ensemble de métriques par rapport à ces dimensions. Si aucune dimension n'est définie (c'est-à-dire si le paramètre URI est vide), un rapport est généré pour toutes les API présentes dans l'environnement spécifié.
- Ensemble de paramètres de requête qui définissent les métriques, la période, l'intervalle de temps et les aspects de filtrage/d'exploration du rapport.
dimension_name: paramètre d'URI qui définit l'entité pour laquelle les métriques de la plate-forme API doivent être récupérées. Apigee définit un ensemble de dimensions pouvant être utilisées dans les rapports. Les dimensions acceptées sont les suivantes:
/stats/apis: proxys d'API dans une organisation sur la plate-forme API/stats/apiproducts: produits d'API définis dans une organisation/stats/apps: nom de l'application de développement qui envoie la requête à votre API/stats/client_ip: adresses IP des applications qui envoient la requête aux API sur la plate-forme API/stats/developer_email: adresse e-mail d'un développeur enregistré dans une organisation sur la plate-forme API/stats/developer_app: nom de l'application de développement qui envoie la requête à votre API/stats/devs:ID de développeur unique généré par Edge enregistré dans une organisation sur la plate-forme API/stats/access_token: jeton d'accès OAuth de l'utilisateur final de l'application
Les filtres peuvent être appliqués aux ressources personnalisées. Les ressources personnalisées sont:
| Symbole | Opération |
|---|---|
in |
pour inclure une liste |
notin |
pour exclure des listes |
eq |
= |
ne |
!= ou |
gt |
> |
lt |
|
ge |
>= |
le |
| Description | Filtrer la structure de la requête |
|---|---|
| Statistiques pour les proxys d'API nommés api1 ou api2 | filter=(apiproxy in 'api1','api2') |
| Statistiques pour tous les proxys d'API, sauf api1 et api2 | filter=(apiproxy notin 'ap1','api2') |
| Statistiques qui ne contiennent aucune erreur | filter=(iserror eq 0) |
| Statistiques en l'absence de messages d'erreur ou lorsque le nom du proxy de l'API est api1 ou api2 | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| Statistiques où (le code de réponse est 201 ou 301) et (il y a des erreurs) ou (le nom de proxy de l'API est api1 ou api2) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or
(apiproxy in 'api1','api2') |
Exemple de requête:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/{dimension_name}?"select={metric_name}&timeRange=1/1/2013%2000:00~1/2/2013%2000:00&timeUnit=hour&sortby={metric_name}&sort=DESC&filter=(apiproxy%20in%20'weather','news')" \
-u myname:mypass
| Nom | Description | Par défaut | Requis ? |
|---|---|---|---|
| select | Désigne la métrique à agréger pour le rapport. Les métriques acceptées sont message_count, error_count, total_response_time, max_response_time, min_response_time, data_Exchange_size et end_point_response_time. | N/A | Oui |
| timeRange | Les heures de début et de fin pour l'intervalle souhaité. Le format de la date est MM/JJ/AAAA HH:MM. Exemple : 1/1/2013%2000:00~1/2/2013%2000:00. La période maximale est de six mois | N/A | Oui |
| timeUnit | seconde, minute, heure, jour, semaine, mois, trimestre, année, décennie, siècle, millénaire | N/A | Oui |
| trier par | Lorsque plusieurs valeurs de sélection sont spécifiées, vous pouvez utiliser "sortby" pour spécifier la sélection utilisée pour le tri des résultats: message_count, error_count, total_response_time, max_response_time, min_response_time, data_Exchange_size, end_point_response_time | N/A | Non |
| sort | Les champs d'application de tri acceptés sont DESC ou ASC | N/A | Non |
| Topk | Prenez "top k" des résultats, par exemple, pour renvoyer les 5 premiers résultats "topk=5". | N/A | Non |
| filtre | Permet d'afficher le détail de valeurs de dimension spécifiques | N/A | Non |
| limite | Définir la limite du nombre d'entrées renvoyées par l'API | N/A | Non |
| offset | Utilisez un décalage avec une limite pour activer la pagination des résultats. Par exemple, pour afficher les résultats 11 à 20, définissez la limite sur "10" et le décalage sur "10". | N/A | Non |
{
"environments" : [ {
"dimensions" : [ {
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
} ,
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api1"
},
{
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
},
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api2"
}
],
"name" : "test"
}
],
"metaData" : {
}
}
Éléments de charge utile de la réponse:
| Nom | Description |
|---|---|
| métadonnées | Métadonnées associées au rapport |
| environments | Environnements de l'organisation où les statistiques sont collectées (prend en charge le caractère générique * pour la collecte de statistiques inter-environnements) |
| metrics | Les valeurs renvoyées pour la dimension spécifiée |
| dimensions | La dimension définie pour la mesure: dans cet exemple, "api_name". |
| metrics | Métriques du rapport |