名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
アクティブな Microsoft Graph API使用状況に関する情報を提供するレポートを取得します。 返されるデータは、コンマ区切りストリームで提供されます。 各行は、1 日分のデータを表します。 特定の日にトラフィックが測定されなかった場合、その日のデータ行は含まれません。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | Reports.Read.All | 注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | サポートされていません。 | サポートされていません。 |
手記： API を呼び出すユーザーには、グローバル閲覧者ロールまたはグローバル管理者ロールが必要です。 ユーザー ロールの詳細については、「Microsoft Entra組み込みロール」を参照してください。
HTTP 要求
GET /reports/getApiUsage(period={period_value},serviceArea={service_area},appId={appId})
関数パラメーター
要求 URL で、必要に応じて、有効な値を持つ次のパラメーターの 1 つ以上を指定します。
| パラメーター | 型 | 説明 |
|---|---|---|
| appId | String | 省略可能。 API によって返されるデータをフィルター処理するためのアプリ ID を指定します。 既定では、API はテナント内のすべてのアプリのデータを返します。 |
| period | String | 省略可能。 レポートを集計する期間の長さを指定します。 {period_value} でサポートされている値は、 D7、 D30、 D60です。 これらの値は、Dn の形式 (n はレポートを集計する日数) に従います。 既定値は D30 です。 |
| serviceArea | String | 省略可能。 データをフィルター処理する必要があるサービス領域 (Microsoft Exchange、Microsoft Teams メッセージング、Microsoft Teams通話、またはMicrosoft Teamsプレゼンス) を指定します。 既定では、API はすべてのサービスエリアのデータを返します。 |
オプションのクエリ パラメーター
このメソッドでは、応答をカスタマイズするための OData クエリ パラメーター はサポートされていません。
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
CSV
成功した場合、このメソッドは 200 OK 応答コードと、応答本文の text/csv 形式のデータを返します。
CSV データには、列の次のヘッダーがあります。
- Date
- サービス分野
- テナント ID
- アプリ ID
- 使用方法
- Active Apps
例
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/reports/getApiUsage(period='D7')
応答
次の例は応答を示しています。
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