Freigeben über

reportRoot: getApiUsage

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Rufen Sie einen Bericht ab, der Informationen zur aktiven Verwendung von Microsoft Graph-API enthält. Die zurückgegebenen Daten werden in einem durch Trennzeichen getrennten Stream bereitgestellt. Jede Zeile stellt einen ganzen Tag mit Daten dar. Wenn an einem bestimmten Tag kein Datenverkehr gemessen wurde, werden keine Datenzeilen für diesen Tag eingeschlossen.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ❌ ❌ ❌

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Reports.Read.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application Nicht unterstützt Nicht unterstützt

Anmerkung: Der Benutzer, der die API aufruft, muss entweder über die Rolle "Globaler Leser" oder "Globaler Administrator" verfügen. Weitere Informationen zu Benutzerrollen finden Sie unter Microsoft Entra integrierten Rollen.

HTTP-Anforderung

GET /reports/getApiUsage(period={period_value},serviceArea={service_area},appId={appId})

Funktionsparameter

Geben Sie in der Anforderungs-URL optional einen oder mehrere der folgenden Parameter mit einem gültigen Wert an.

Parameter Typ Beschreibung
appId Zeichenfolge Optional. Gibt die App-ID zum Filtern der von der API zurückgegebenen Daten an. Standardmäßig gibt die API die Daten für alle Apps innerhalb des Mandanten zurück.
Zeitraum Zeichenfolge Optional. Gibt die Zeitspanne an, für die der Bericht aggregiert wird. Die unterstützten Werte für {period_value} sind: D7, D30und D60. Diese Werte folgen dem Format Dn, wobei n die Anzahl der Tage angibt, für die der Bericht aggregiert wird. Der Standardwert ist D30.
serviceArea Zeichenfolge Optional. Gibt den Dienstbereich (Microsoft Exchange, Microsoft Teams Messaging, Microsoft Teams-Anrufe oder Microsoft Teams-Anwesenheit) an, für den die Daten gefiltert werden sollen. Standardmäßig gibt die API die Daten für alle Dienstbereiche zurück.

Optionale Abfrageparameter

Diese Methode unterstützt keine OData-Abfrageparameter zum Anpassen der Antwort.

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

CSV

Bei erfolgreicher Ausführung gibt die Methode einen 200 OK Antwortcode und Daten im text/csv Format im Antworttext zurück.

Die CSV-Daten weisen die folgenden Header für Spalten auf:

  • Datum
  • Dienstbereich
  • Mandanten-ID
  • App-ID
  • Verwendung
  • Aktive Apps

Beispiel

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/reports/getApiUsage(period='D7')

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 200 OK
Content-Type: text/csv

Date,Service Area,Tenant ID,App ID,Usage,Active Apps
2024-08-28T00:00:00Z,Microsoft Exchange,00000000-0000-0000-0000-000000000000,,5888,2
2024-08-28T00:00:00Z,Microsoft Exchange,00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000,2432,
2024-08-28T00:00:00Z,Microsoft Exchange,00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000,3456,
2024-08-27T00:00:00Z,Microsoft Exchange,00000000-0000-0000-0000-000000000000,,28717,3
2024-08-27T00:00:00Z,Microsoft Exchange,00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000,1800
2024-08-27T00:00:00Z,Microsoft Exchange,00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000,5050
2024-08-28T00:00:00Z,Microsoft Exchange,00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000,21867
  • Last updated on