Logs mit der API ansehen

Sie lesen gerade die Apigee Edge -Dokumentation.
Zur Apigee X -Dokumentation. info

Laden Sie die API Monitoring-Logs herunter, um die Rohdaten zu sehen, mit denen die in den API Monitoring-Dashboards angezeigten Messwerte berechnet werden. Sie können Logs für benutzerdefinierte Zeiträume, bestimmte Proxys, bestimmte Statuscodes und viele andere Variablen herunterladen.

Hinweis: Standardmäßig werden bei Aufrufen der Logs API nur Ergebnisse mit den Statuscodes 4xx und 5xx zurückgegeben, nicht mit dem Code 2xx. Dadurch soll die Anzahl der Ergebnisse begrenzt werden, da die meisten Ergebnisse den Statuscode 2xx haben. Wenn Sie Ergebnisse mit dem Statuscode 2xx erhalten möchten, fügen Sie der Anfrage status=2xx hinzu. Beispiel: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

In den folgenden Abschnitten wird beschrieben, wie Sie Logs mit der API verwalten:

Weitere Informationen zur Logs API finden Sie unter Logs API.

Informationen zu den in diesen Beispielen verwendeten cURL-Optionen finden Sie unter cURL verwenden.

Logs für eine Organisation und Umgebung herunterladen

So laden Sie die Logs für eine bestimmte Organisation und Umgebung mit der Logs API herunter:

https://apimonitoring.enterprise.apigee.com/logs

Sie müssen den Namen der Organisation und Umgebung mit den Suchparametern org und env übergeben.

Standardmäßig gibt die API die letzten 10 Logeinträge für die vorherige Stunde zurück. Beispiel:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Legen Sie für $ACCESS_TOKEN Ihr OAuth 2.0-Zugriffstoken fest, wie unter OAuth 2.0-Zugriffstoken anfordern beschrieben.

Die Antwort ist ein Array von Logeinträgen im folgenden Format:

[   
  {
"request":"GET /v1/o/myorg/z HTTP/1.1",
    "request_length":1349,
    "request_message_id":"rrt-0623eb157b650315c-c-ne-7785-16029140-1",
    "virtual_host":"api.enterprise.apigee.com",
    "response_size":144,
    "response_time":0.551,
    "response_status":"404",
    "timestamp":"2018-08-14T17:31:07Z",
    "fault_code":"messaging.adaptors.http.flow.ErrorResponseCode",
    "fault_flow":"-",
    "fault_policy":"null/null",
    "fault_proxy":
        "/organizations/myorg/environments/prod/apiproxies/myAPI/revisions/50",
    "fault_source":"target"
  },
  …
]

Verwenden Sie die Suchparameter from und to, um einen Zeitraum im ISO-Format anzugeben. Das Datumsformat kann eines der folgenden sein:

  • yyyy-mm-ddThh:mm:ssZ
  • yyyy-mm-ddThh:mm:ss+00:00

Beispiel:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Die API hat viele optionale Abfrageparameter. So rufen Sie beispielsweise die Logs für einen Proxy namens myAPI auf, der HTTP 404-Antworten generiert:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Wenn Sie mehr als 10 Logeinträge zurückgeben möchten, legen Sie den Abfrageparameter limit fest. Sie können ihn auf einen Maximalwert von 1000 festlegen:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404&limit=200" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Weitere Optionen finden Sie unter Logs API.

Proxys auflisten, die einem virtuellen Host und Basispfad zugeordnet sind

Mit einem virtuellen Host auf einem Edge-Router können Sie einen Domainnamen, ein Protokoll wie HTTP/HTTPS und eine Portnummer angeben. Beispielsweise definieren Sie einen virtuellen Host auf einem Edge-Router mit den folgenden Einstellungen:

  • Host-Alias = apis.acme.com
  • Port = 443
  • TLS aktiviert

Basierend auf diesen Einstellungen hat eine Anfrage an einen API-Proxy, der diesem virtuellen Host zugeordnet ist, folgendes Format:

https://apis.acme.com/proxy-base-path/resource-path

Wobei:

  • proxy-base-path wird beim Erstellen eines API-Proxys definiert und ist für jeden API-Proxy eindeutig.
  • resource-path ist der Pfad zu einer Ressource, auf die über den API-Proxy zugegriffen werden kann.

Weitere Informationen zu virtuellen Hosts finden Sie unter Informationen zu virtuellen Hosts.

Laden Sie die Liste der API-Proxys herunter, die einem bestimmten virtuellen Host und Basispfad zugeordnet sind. Senden Sie dazu eine GET-Anfrage an die folgende Ressource der Logs API:

https://apimonitoring.enterprise.apigee.com/logs/apiproxies

Sie müssen den Namen der Organisation und Umgebung mit den Suchparametern org und env sowie den URI übergeben, der dem virtuellen Host und Basispfad zugeordnet ist.

Der folgende API-Aufruf gibt beispielsweise die Proxys zurück, die dem virtuellen Host http://apis.acme.com und dem Basispfad /v1/perf zugeordnet sind:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=myorg&env=prod&select=http://apis.acme.com/v1/perf" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Legen Sie für $ACCESS_TOKEN Ihr OAuth 2.0-Zugriffstoken fest, wie unter OAuth 2.0-Zugriffstoken anfordern beschrieben.

Weitere Optionen finden Sie unter Logs API.