cloudPcReports: retrieveConnectionQualityReports

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Получение общих отчетов о качестве подключения для всех устройств в текущем клиенте. К ним относятся отчет о тенденциях качества региональных подключений и отчет о качестве региональных подключений, включая время кругового пути, доступную пропускную способность, использование UPD и разрыв подключений.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ❌ ❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

|Делегировано (рабочая или учебная учетная запись)|CloudPC.Read.All|CloudPC.ReadWrite.All| |Делегировано (личная учетная запись Майкрософт)|Не поддерживается.|Не поддерживается.| |Приложение|CloudPC.Read.All|CloudPC.ReadWrite.All|

HTTP-запрос

POST /deviceManagement/virtualEndpoint/reports/retrieveConnectionQualityReports

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление параметров в формате JSON.

В следующей таблице указаны параметры, которые можно использовать с этим действием.

Параметр Тип Описание
filter String Синтаксис OData $filter . Поддерживаемые фильтры: and, or, lt, le, gt, geи eq.
groupBy Коллекция строк Указывает, как группировать отчеты. Если используется, содержимое должно совпадать с параметром select .
orderBy Коллекция строк Указывает способ сортировки отчетов.
search String Указывает строку для поиска.
select Коллекция строк Синтаксис OData $select . Выбранные столбцы отчетов.
skip Int32 Количество пропущенных записей.
top Int32 Количество возвращаемых верхних записей.

Отклик

В случае успешного 200 OK выполнения это действие возвращает код ответа и Stream в тексте ответа.

В следующей таблице описаны столбцы в возвращаемом отчете при указании regionalConnectionQualityTrendReport свойства reportName в вызове API.

Member Описание
AvailableBandwidthTrend Тенденция в средней доступной пропускной способности за неделю. Тенденция вычисляется с помощью линейной регрессии за четыре недели данных. Значения могут быть Increasing (наклон > 15), Decreasing (наклон < -15) или Static (в противном случае).
DailyAvailableBandwidthInMbps Средняя доступная пропускная способность в Мбит/с за последний день.
DailyAvgRoundTripTimeInMs Среднее ежедневное время кругового пути в миллисекундах за последний день.
DailyDroppedConnectionsCount Ежедневное число удаленных подключений за последний день.
DailyWeeklyUdpUtilization Средний процент использования UDP в день за последний день.
DroppedConnectionTrend Тенденция в еженедельном соотношении удаленных подключений к общему количеству устройств в регионе. Тенденция вычисляется с помощью линейной регрессии за четыре недели данных. Значения могут быть Increasing (наклон > 0,1), Decreasing (наклон < -0,1) или Static (в противном случае).
GatewayRegion Регион, в котором расположен шлюз.
RoundTripTimeTrend Тенденция в среднем еженедельном времени кругового пути. Тенденция вычисляется с помощью линейной регрессии за четыре недели данных. Значения могут быть Increasing (наклон > 10), Decreasing (наклон < -10) или Static (в противном случае).
UDPUtilizationTrend Тенденция среднего еженедельного использования UDP. Тенденция вычисляется с помощью линейной регрессии за четыре недели данных. Значения могут быть Increasing (наклон > 0,1), Decreasing (наклон < -0,1) или Static (в противном случае).
WeeklyAvailableBandwidthInMbps Средняя доступная еженедельная пропускная способность в Мбит/с. Еженедельный период начинается с воскресенья по текущий день.
WeeklyAvgRoundTripTimeInMs Среднее еженедельное время кругового пути в миллисекундах. Еженедельный период начинается с воскресенья по текущий день.
WeeklyDroppedConnectionsCount Еженедельное число удаленных подключений. Еженедельный период начинается с воскресенья по текущий день.
WeeklyUdpUtilization Средний процент использования UDP за неделю. Еженедельный период начинается с воскресенья по текущий день.

Примеры

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveConnectionQualityReports
Content-Type: application/json
Content-length: 200

{
    "reportName":"regionalConnectionQualityTrendReport",
    "filter": "",
    "select": ["GatewayRegion", "RoundTripTimeTrend", "AvailableBandwidthTrend", "UDPUtilizationTrend", "DroppedConnectionTrend", "WeeklyAvgRoundTripTimeInMs", "DailyAvgRoundTripTimeInMs", "WeeklyAvailableBandwidthInMbps", "DailyAvailableBandwidthInMbps", "WeeklyUdpUtilization", "DailyWeeklyUdpUtilization", "WeeklyDroppedConnectionsCount", "DailyDroppedConnectionsCount"],
    "search": "",
    "skip": 0,
    "top": 50
}

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

{
    "TotalRowCount": 2,
    "Schema": [
        {
            "Column": "GatewayRegion",
            "PropertyType": "String"
        },
        {
            "Column": "RoundTripTimeTrend",
            "PropertyType": "String"
        },
        {
            "Column": "AvailableBandwidthTrend",
            "PropertyType": "String"
        },
        {
            "Column": "UDPUtilizationTrend",
            "PropertyType": "String"
        },
        {
            "Column": "DroppedConnectionTrend",
            "PropertyType": "String"
        },
        {
            "Column": "WeeklyAvgRoundTripTimeInMs",
            "PropertyType": "Double"
        },
        {
            "Column": "DailyAvgRoundTripTimeInMs",
            "PropertyType": "Double"
        },
        {
            "Column": "WeeklyAvailableBandwidthInMbps",
            "PropertyType": "Double"
        },
        {
            "Column": "DailyAvailableBandwidthInMbps",
            "PropertyType": "Double"
        },
        {
            "Column": "WeeklyUdpUtilization",
            "PropertyType": "Double"
        },
        {
            "Column": "DailyWeeklyUdpUtilization",
            "PropertyType": "Double"
        },
        {
            "Column": "WeeklyDroppedConnectionsCount",
            "PropertyType": "Int32"
        },
        {
            "Column": "DailyDroppedConnectionsCount",
            "PropertyType": "Int32"
        }
    ],
    "Values" :[
        ["Japan East", "Increasing", "Decreasing", "Static", "Decreasing", "296.25", "350.50", "3.1", "2,1", "51.2", "47.8", "19", "29"],
        ["Southeast Asia", "Decreasing", "Static", "Increasing", "Increasing", "337.14", "299.50", "1.7", "2,2", "33.5", "67.8", "17", "16"],
    ]
}
  • Last updated on