Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu
Apigee X. info
Basispfad der API-Plattform:
https://api.enterprise.apigee.com/v1/o/{org_name}
Pfad der API-Ressource:/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 mit einer GET-Anfrage an die
/stats API
Ressource generiert. Dabei werden folgende Elemente verwendet:
- 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 in der angegebenen Umgebung vorhandenen APIs generiert.
- Eine Reihe von Abfrageparametern, die die Messwerte, den Zeitraum, das Zeitintervall und Filter-/Detailaspekte des Berichts definieren.
dimension_name: Ein URI-Parameter, der die Entität definiert, für die die API
Plattform-Messwerte abgerufen werden sollen. Apigee definiert eine Reihe von Dimensionen, die in
Berichten verwendet werden können. Zu den unterstützten Dimensionen gehören:
/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 sendet/stats/client_ip: IP-Adressen von Apps, die die Anfrage an APIs auf der API Plattform senden/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 sendet/stats/devs:Die eindeutige von Edge generierte Entwickler-ID, die in einer Organisation auf der API-Plattform registriert ist/stats/access_token: Das OAuth-Zugriffstoken des Endnutzers der App
Filter können auf benutzerdefinierte Ressourcen angewendet werden. Benutzerdefinierte Ressourcen sind:
| Symbol | Vorgang |
|---|---|
in |
für Listeneinschluss |
notin |
für Listenausschluss |
eq |
= |
ne |
!= oder |
gt |
> |
lt |
|
ge |
>= |
le |
| Beschreibung | Struktur der Filterabfrage |
|---|---|
| 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 ohne Fehlermeldungen oder mit dem API-Proxy-Namen „api1“ oder „api2“ | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| Statistiken, bei denen (der Antwortcode entweder 201 oder 301 ist) und (Fehler vorhanden sind) oder (der API-Proxy Name entweder „api1“ oder „api2“ ist) | 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? |
|---|---|---|---|
| select | Gibt den Messwert an, der für den Bericht aggregiert werden soll. Unterstützte Messwerte sind „message_count“, „error_count“, „total_response_time“, „max_response_time“, „min_response_time“, „data_exchange_size“ und „end_point_response_time“. | – | Ja |
| timeRange | Start- und Endzeit für das gewünschte Intervall. Das Datumsformat ist MM/TT/JJJJ HH:MM. Beispiel: 1/1/2013%2000:00~1/2/2013%2000:00. Der maximal zulässige Zeitraum beträgt sechs Monate. | – | Ja |
| timeUnit | „second“, „minute“, „hour“, „day“, „week“, „month“, „quarter“, „year“, „decade“, „century“, „millennium“ | – | Ja |
| sortby | Wenn zwei oder mehr Auswahlwerte angegeben sind, kann mit „sortby“ die Auswahl angegeben werden, die zum 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 | Übernehmen Sie die „k“ besten Ergebnisse aus den Ergebnissen. Wenn Sie beispielsweise die fünf besten Ergebnisse zurückgeben möchten, verwenden Sie „topk=5“. | – | Nein |
| filter | Ermöglicht das Aufschlüsseln nach bestimmten Dimensionswerten. | – | Nein |
| limit | Legen Sie das Limit für die Anzahl der von der API zurückgegebenen Einträge fest. | – | Nein |
| offset | Verwenden Sie „offset“ mit „limit“, um die Paginierung der Ergebnisse zu aktivieren. Wenn Sie beispielsweise die Ergebnisse 11 bis 20 anzeigen möchten, legen Sie für „limit“ den Wert „10“ und für „offset“ den Wert „10“ fest. | – | 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" : {
}
}| Name | Beschreibung |
|---|---|
| metadata | Metadaten, die dem Bericht zugeordnet sind |
| environments | Umgebungen in der Organisation, in der die Statistiken erfasst werden (unterstützt das Platzhalterzeichen * für die Erfassung von Statistiken über mehrere Umgebungen hinweg) |
| metrics | Die für die angegebene Dimension zurückgegebenen Werte |
| dimensions | Die für die Messung definierte Dimension, in diesem Beispiel „api_name“. |
| metrics | Messwerte für den Bericht |