Vous consultez la documentation Apigee Edge.
Accédez à la
documentation**Apigee X**. info
Chemin de base de la plate-forme d'API :
https://api.enterprise.apigee.com/v1/o/{org_name}
Chemin de la ressource d'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 contenu : |
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 des éléments suivants :
- Un paramètre d'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 d'URI est vide), un rapport est généré pour toutes les API présentes dans l'environnement spécifié.
- Un 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 d'API
doivent être récupérées. Apigee définit un ensemble de dimensions qui peuvent être utilisées dans les
rapports. Les dimensions acceptées incluent les suivantes :
/stats/apis: proxys d'API dans une organisation sur la plate-forme d'API/stats/apiproducts: produits d'API définis dans une organisation/stats/apps: nom de l'application de développeur 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 d'API/stats/developer_email: adresse e-mail d'un développeur enregistré dans une organisation sur la plate-forme d'API/stats/developer_app: nom de l'application de développeur qui envoie la requête à votre API/stats/devs: ID de développeur unique généré par Edge et enregistré dans une organisation sur la plate-forme d'API/stats/access_token: jeton d'accès OAuth de l'utilisateur final de l'application
Des filtres peuvent être appliqués aux ressources personnalisées. Les ressources personnalisées sont les suivantes :
| Symbole | Opération |
|---|---|
in |
pour l'inclusion dans une liste |
notin |
pour l'exclusion d'une liste |
eq |
= |
ne |
!= ou |
gt |
> |
lt |
|
ge |
>= |
le |
| Description | Structure de la requête de filtre |
|---|---|
| Statistiques pour les proxys d'API nommés api1 ou api2 | filter=(apiproxy in 'api1','api2') |
| Statistiques pour tous les proxys d'API, à l'exception d'api1 et d'api2 | filter=(apiproxy notin 'ap1','api2') |
| Statistiques sans erreur | filter=(iserror eq 0) |
| Statistiques sans message d'erreur ou dont le nom du proxy d'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 du proxy d'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 | Obligatoire ? |
|---|---|---|---|
| sélectionner | 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 | Heure de début et de fin de l'intervalle souhaité. Le format de date est MM/JJ/AAAA HH:MM. Par exemple, 01/01/2013%2000:00~02/01/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 deux valeurs de sélection ou plus sont spécifiées, "sortby" peut être utilisé pour spécifier la sélection utilisée pour trier les résultats : message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size et end_point_response_time. | N/A | Non |
| trier | Les étendues de tri acceptées sont DESC ou ASC. | N/A | Non |
| top-K | Prenez les "k" premiers résultats, par exemple, pour renvoyer les cinq premiers résultats "topk=5". | N/A | Non |
| filtre | Permet d'explorer des valeurs de dimension spécifiques. | N/A | Non |
| limite | Définissez la limite du nombre d'entrées renvoyées par l'API. | N/A | Non |
| offset | Utilisez l'offset avec la limite pour activer la pagination des résultats. Par exemple, pour afficher les résultats 11 à 20, définissez la limite sur « 10 » et l’offset 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 dans lesquels les statistiques sont collectées (accepte le caractère générique * pour la collecte de statistiques inter-environnements) |
| métrique | Valeurs renvoyées pour la dimension spécifiée |
| dimensions | Dimension définie pour la mesure : dans cet exemple, api_name. |
| métrique | Métriques du rapport |