通过

cloudPcReports：retrieveConnectionQualityReports

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

获取当前租户中所有设备的总体连接质量报告。 这包括区域连接质量趋势报告和区域连接质量见解报告，包括往返时间、可用带宽、UPD 使用情况和断开连接。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

|委派 (工作或学校帐户) |CloudPC.Read.All |CloudPC.ReadWrite.All | |委派 (个人Microsoft帐户) |不支持。|不支持。||应用程序|CloudPC.Read.All |CloudPC.ReadWrite.All |

HTTP 请求

POST /deviceManagement/virtualEndpoint/reports/retrieveConnectionQualityReports

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

在请求正文中，提供参数的 JSON 表示形式。

下表显示了可用于此操作的参数。

参数 类型 说明
filter String OData $filter 语法。 支持的筛选器包括：and、、or、ltle、gt、 ge和 eq。
groupBy 字符串集合 指定如何对报表进行分组。 如果使用，则必须具有与 select 参数相同的内容。
orderBy 字符串集合 指定如何对报表进行排序。
search String 指定要搜索的字符串。
select 字符串集合 OData $select 语法。 报表的选定列。
skip Int32 要跳过的记录数。
top Int32 要返回的排名靠前的记录数。

响应

如果成功，此作将在200 OK响应正文中返回响应代码和Stream。

下表描述了在 API 调用中为 reportName 属性指定regionalConnectionQualityTrendReport时返回的报表中的列。

成员 说明
AvailableBandwidthTrend 每周平均可用带宽的趋势。 使用四周数据中的线性回归来计算趋势。 值可以是 Increasing (斜率 > 15) 、 Decreasing (斜率 < -15) ，或者 Static () 。
DailyAvailableBandwidthInMbps 最近一天的每日平均可用带宽（以 Mbps 为单位）。
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 每周平均可用带宽（以 Mbps 为单位）。 每周时段从星期日到当天开始。
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