Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
API-Plattform-Basispfad:
https://api.enterprise.apigee.com/v1/o/{org_name}
API-Ressourcenpfad: /environments/{env_name}/stats/{dimension_name}
Beschreibung:Verwenden Sie die GET-Methode, um Messwerte für eine Dimension abzurufen.
| Verb: | GET |
| Authentifizierung: | Basisauthentifizierung |
| Medientypen: |
application/json
|
Übersicht: Ein Bericht wird mithilfe einer GET-Anfrage für die API-Ressource
/stats generiert. Dazu wird Folgendes benötigt:
- Ein optionaler URI-Parameter, der die Dimension für den Bericht definiert. Apigee definiert eine Reihe von Dimensionen und aggregiert eine Reihe von Messwerten anhand dieser Dimensionen. Wenn keine Dimension definiert ist, d.h. wenn der URI-Parameter leer ist, wird ein Bericht für alle APIs in der angegebenen Umgebung generiert.
- Eine Reihe von Abfrageparametern, die die Messwerte, den Zeitraum, das Zeitintervall und die Filter-/Aufschlüsselungsaspekte des Berichts definieren.
dimension_name: Ein URI-Parameter, der die Entität definiert, für die die API Platform-Messwerte abgerufen werden sollen. Apigee definiert eine Reihe von Dimensionen, die in Berichten verwendet werden können. Folgende Dimensionen werden unterstützt:
/stats/apis: API-Proxys in einer Organisation auf der API-Plattform/stats/apiproducts: In einer Organisation definierte API-Produkte/stats/apps: der Name der Entwickler-App, die die Anfrage an Ihre API stellt/stats/client_ip: IP-Adressen von Anwendungen, die die Anfrage an APIs auf der API-Plattform stellen/stats/developer_email: Die E-Mail-Adresse eines Entwicklers, der in einer Organisation auf der API-Plattform registriert ist/stats/developer_app: Der Name der Entwickler-App, die die Anfrage an Ihre API stellt/stats/devs:die von Edge generierte Entwickler-ID, die in einer Organisation auf der API-Plattform registriert ist/stats/access_token: OAuth-Zugriffstoken des App-Endnutzers
Filter können auf benutzerdefinierte Ressourcen angewendet werden. Benutzerdefinierte Ressourcen sind:
| Symbol | Vorgang |
|---|---|
in |
für die Aufnahme in die Liste |
notin |
für Listenausschluss |
eq |
= |
ne |
!= oder |
gt |
> |
lt |
|
ge |
>= |
le |
| Beschreibung | Abfragestruktur filtern |
|---|---|
| Statistiken für API-Proxys mit dem Namen api1 oder api2 | filter=(apiproxy in 'api1','api2') |
| Statistiken für alle API-Proxys außer api1 und api2 | filter=(apiproxy notin 'ap1','api2') |
| Statistiken ohne Fehler | filter=(iserror eq 0) |
| Statistiken, bei denen keine Fehlermeldungen vorliegen oder der API-Proxy-Name api1 oder api2 ist | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| Statistiken mit (Antwortcode ist entweder 201 oder 301) und (es gibt Fehler) oder (API-Proxy-Name ist entweder api1 oder api2) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or
(apiproxy in 'api1','api2') |
Beispielanfrage:
$ 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
| Name | Beschreibung | Standard | Erforderlich? |
|---|---|---|---|
| wähle | Gibt den zu aggregierenden Messwert für den Bericht an. Unterstützte Messwerte sind message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | – | Ja |
| timeRange | Start- und Endzeit für das gewünschte Intervall. Das Datumsformat ist MM/TT/JJJJ HH:MM, z. B. 1/1/2013%2000:00~1/2/2013%2000:00. Der maximale Zeitraum beträgt sechs Monate | – | Ja |
| timeUnit | Sekunde, Minute, Stunde, Tag, Woche, Monat, Quartal, Jahr, Jahrzehnt, Jahrhundert, Jahrtausend | – | Ja |
| Sortieren nach | Wenn zwei oder mehr Auswahlwerte angegeben sind, kann mit „sortby“ die Auswahl angegeben werden, die für das Sortieren der Ergebnisse verwendet wird: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time. | – | Nein |
| sort | Unterstützte Sortierbereiche sind DESC oder ASC | – | Nein |
| Topk | Nehmen wir „top k“-Ergebnisse aus Ergebnissen, um beispielsweise die fünf besten Ergebnisse „topk=5“ zurückzugeben. | – | Nein |
| Filter | Aktiviert die Aufschlüsselung bestimmter Dimensionswerte | – | Nein |
| Limit | Legen Sie das Limit für die Anzahl der von der API zurückgegebenen Einträge fest | – | Nein |
| kompensiert | Verwenden Sie den Offset mit dem Limit, um die Paginierung der Ergebnisse zu aktivieren. Um beispielsweise die Ergebnisse 11–20 anzuzeigen, setzen Sie den Grenzwert auf „10“ und den Versatz auf „10“. | – | Nein |
{
"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" : {
}
}
Antwortnutzlastelemente:
| Name | Beschreibung |
|---|---|
| Metadaten | Mit dem Bericht verknüpfte Metadaten |
| environments | Umgebungen in der Organisation, in denen die Statistiken erfasst werden (unterstützt Platzhalter * für die Erfassung von Umgebungsstatistiken) |
| metrics | Die für die angegebene Dimension zurückgegebenen Werte |
| Dimensionen | Die für die Messung definierte Dimension, in diesem Beispiel „api_name“. |
| metrics | Messwerte für den Bericht |