reportRoot: getOneDriveUsageFileCounts
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получение общего количества файлов на всех сайтах и количества активных файлов. Файл считается активным, если он был сохранен, синхронизирован или изменен либо им поделились в указанный период.
Заметка: Дополнительные сведения о различных представлениях и именах отчетов см. в статье Отчеты Microsoft 365 — использование OneDrive для бизнеса.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | Reports.Read.All | Недоступно. |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Для приложений | Reports.Read.All | Недоступно. |
Примечание. Чтобы делегированные разрешения разрешали приложениям читать отчеты об использовании служб от имени пользователя, администратор клиента должен назначить пользователю соответствующую ограниченную роль администратора Microsoft Entra ID. Дополнительные сведения см. в статье Авторизация для API с целью чтения отчетов об использовании Microsoft 365.
HTTP-запрос
GET /reports/getOneDriveUsageFileCounts(period='{period_value}')
Параметры функции
В URL-адресе запроса укажите приведенный ниже параметр и действительное значение.
Параметр | Тип | Описание |
---|---|---|
period | string | Указывает отчетный период. Поддерживаемые значения {period_value}: D7, D30, D90 и D180. Эти значения указываются в формате Dn, где n — количество дней в отчетном периоде. Обязательный. |
Этот метод поддерживает $format
параметр запроса OData для настройки ответа. Тип выходных данных по умолчанию — text/csv. Однако если вы хотите указать тип выходных данных, можно использовать параметр запроса OData $format, для которого задано значение text/csv или application/json.
Заголовки запросов
Имя | Описание |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Отклик
CSV
В случае успешного выполнения этот метод возвращает отклик 302 Found
, который перенаправляет на URL-адрес, для которого выполнена предварительная аутентификация, для скачивания отчета. Этот URL-адрес можно найти в заголовке Location
отклика.
URL-адреса для скачивания, для которых выполнена предварительная аутентификация, действительны в течение нескольких минут и не требуют заголовка Authorization
.
CSV-файл содержит столбцы со следующими заголовками:
- "Report Refresh Date" (Дата обновления отчета);
- "Site Type" (Тип сайта);
- "Total" (Всего);
- Active (активные)
- Report Date (дата отчета)
- "Report Period" (Отчетный период).
JSON
В случае успешного выполнения этот метод возвращает код отклика 200 OK
и объект JSON в тексте отклика.
Пример
CSV
Ниже приведен пример вывода CSV-файла.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/reports/getOneDriveUsageFileCounts(period='D7')?$format=text/csv
Отклик
Ниже показан пример отклика.
HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe
У скачанного после перенаправления 302 CSV-файла будет приведенная ниже схема.
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Report Refresh Date,Site Type,Total,Active,Report Date,Report Period
JSON
Ниже приведен пример, возвращающий JSON.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/reports/getOneDriveUsageFileCounts(period='D7')?$format=application/json
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 251
{
"value": [
{
"reportRefreshDate": "2017-09-01",
"siteType": "All",
"total": 297960,
"active": 4679,
"reportDate": "2017-09-01",
"reportPeriod": "7"
}
]
}