<ph type="x-smartling-placeholder"></ph>
Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie 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: | HERUNTERLADEN |
| Authentifizierung: | Basisauthentifizierung |
| Medientypen: |
application/json
|
Übersicht:Ein Bericht wird mithilfe einer GET-Anfrage an die
/stats API erstellt.
Ressource begleitet von:
- Ein optionaler URI-Parameter, der die Dimension für den Bericht definiert. Apigee definiert eine Menge von Dimensionen wird eine Reihe von Messwerten für diese Dimensionen vorab zusammengefasst. Wenn keine Dimension gleich definiert (d. h. wenn der URI-Parameter leer ist), wird ein Bericht für alle APIs generiert. in der angegebenen Umgebung vorhanden ist.
- Eine Reihe von Abfrageparametern, die Messwerte, Zeitraum, Zeitintervall und Filter-/Aufschlüsselungsaspekte des Berichts.
dimension_name: Ein URI-Parameter, der die Entität definiert, für die die API verwendet wird.
Plattformmesswerte sollten abgerufen werden. Apigee definiert eine Reihe von Dimensionen, die in
Berichte. 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 sendet/stats/client_ip: IP-Adressen von Anwendungen, die die Anfrage an APIs in der API stellen Plattform/stats/developer_email: die E-Mail-Adresse eines Entwicklers, der in einem Unternehmen auf der API-Plattform/stats/developer_app: Der Name der Entwickler-App, die die Anfrage an Ihre API/stats/devs:Die eindeutige von Edge generierte Entwickler-ID, die in einem auf der API-Plattform/stats/access_token: Das OAuth-Zugriffstoken des App-Endbenutzers
Filter können auf benutzerdefinierte Ressourcen angewendet werden. Benutzerdefinierte Ressourcen sind:
| Symbol | Vorgang |
|---|---|
in |
zur Listenaufnahme |
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 angezeigt werden 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? |
|---|---|---|---|
| auswählen | Gibt den Messwert an, der für den Bericht aggregiert werden soll. Unterstützte Messwerte: 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. Beispiel: 1/1/2013%2000:00~1/2/2013%2000:00. Der maximale Zeitraum beträgt 6 Monate | – | Ja |
| timeUnit | Sekunde, Minute, Stunde, Tag, Woche, Monat, Quartal, Jahr, Jahrzehnt, Jahrhundert, Jahrtausend | – | Ja |
| Sortieren nach | Wenn zwei oder mehr Auswahlwerte angegeben sind, wird „sortby“ verwendet. kann verwendet werden, Zum Sortieren der Ergebnisse verwendete auswählen: 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 | "Top K" nehmen Ergebnisse aus Ergebnissen, um z. B. die ersten 5 Ergebnisse zurückzugeben „topk=5“. | – | Nein |
| Filter | Aktiviert die Aufschlüsselung bestimmter Dimensionswerte | – | Nein |
| Limit | Limit für die Anzahl der von der API zurückgegebenen Einträge festlegen | – | Nein |
| kompensiert | Verwenden Sie den Offset mit dem Grenzwert, um die Paginierung der Ergebnisse zu ermöglichen. Um beispielsweise Ergebnisse anzuzeigen, 11–20, Limit auf „10“ festlegen und einen Versatz von '10' ein. | – | 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 |
|---|---|
| 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) |
| Messwerte | Die Werte, die für die angegebene Dimension zurückgegeben werden |
| Dimensionen | Die für die Messung definierte Dimension, in diesem Beispiel „api_name“. |
| Messwerte | Messwerte für den Bericht |