<ph type="x-smartling-placeholder"></ph>
Vous consultez la documentation Apigee Edge.
Accédez à la page
Documentation sur Apigee X. En savoir plus
Chemin de base de la plate-forme d'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 des métriques pour une dimension.
| Verbe: | OBTENIR |
| 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 l'API
/stats.
ressource, accompagnée de:
- Paramètre d'URI facultatif qui définit la dimension pour le rapport. Apigee définit un ensemble un ensemble de métriques par rapport à ces dimensions. Si aucune dimension n'est (si le paramètre URI est vide, par exemple), un rapport est généré pour toutes les API dans l'environnement spécifié.
- Un ensemble de paramètres de requête définissant les métriques, la période, l'intervalle de temps et filtrer/explorer les aspects du rapport.
dimension_name: paramètre d'URI qui définit l'entité pour laquelle l'API
Les métriques de la plate-forme doivent être récupérées. Apigee définit un ensemble de dimensions pouvant être utilisées
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 l'API. Plate-forme/stats/developer_email: adresse e-mail d'un développeur enregistré dans un sur la plate-forme d'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 un sur la plate-forme d'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 |
à inclure dans une liste |
notin |
pour l'exclusion de liste |
eq |
= |
ne |
!= ou |
gt |
> |
lt |
|
ge |
>= |
le |
| Description | Filtrer la structure de 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 pour lesquelles il n'y a pas d'erreurs | filter=(iserror eq 0) |
| Statistiques où il n'y a pas de message d'erreur ou 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 (proxy d'API) le nom 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 | Obligatoire ? |
|---|---|---|---|
| select | Désigne la métrique à agréger pour le rapport. Les métriques acceptées sont les suivantes : message_count, error_count, total_response_time, max_response_time, min_response_time, taille_échange_données, heure_réponse_point_de_fin | N/A | Oui |
| Période | Les heures de début et de fin de l'intervalle souhaité. Le format de date est MM/JJ/AAAA HH:MM. Par exemple, 1/1/2013%2000:00~1/2/2013%2000:00. La période maximale est de 6 mois | N/A | Oui |
| Unité de temps | seconde, minute, heure, jour, semaine, mois, trimestre, année, décennie, siècle, millénaire | N/A | Oui |
| Trier par : | Lorsque deux valeurs de sélection ou plus sont spécifiées, "sortby" permet de spécifier sélectionnez utilisé pour trier les résultats: message_count, error_count, total_response_time, max_response_time, min_response_time, data_échange_size, end_point_response_time | N/A | Non |
| trier | Les niveaux de tri pris en charge sont DESC ou ASC | N/A | Non |
| top-K | Prendre "top k" dans les résultats, par exemple, pour afficher 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 le nombre maximal d'entrées renvoyées par l'API | N/A | Non |
| offset | Utilisez offset avec limite pour activer la pagination des résultats. Par exemple, pour afficher les résultats 11-20, définir 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" : {
}
}| Nom | Description |
|---|---|
| métadonnées | Métadonnées associées au rapport |
| environments | Environnements de l'organisation où les statistiques sont collectées (accepte les caractères génériques * pour la collecte de statistiques multi-environnements) |
| métrique | Les valeurs renvoyées pour la dimension spécifiée |
| dimensions | La dimension définie pour la mesure: dans cet exemple, api_name. |
| métrique | Métriques du rapport |