通过

按定义获取扫描历史记录

  • 适用于: Microsoft Defender for Endpoint, Microsoft Defender for Endpoint Plan 1, Microsoft Defender Vulnerability Management, Microsoft Defender for Business

重要

本文中的某些信息与预发行的产品有关，该产品在商业发布之前可能有重大修改。 Microsoft 对此处所提供的信息不作任何明示或默示的保证。

API 说明

按定义检索扫描历史记录的列表。

  • 支持 OData作。
  • OData 支持的运算符：
    • 最大值为 4096 的$top。 返回请求中指定的会话数。
    • 默认值为 0 的$skip。 跳过请求中指定的会话数。

有关 OData作用法的示例，请参阅 请求$top示例。

限制

此 API 的速率限制是每分钟 100 个调用和每小时 1,500 个调用。

权限

使用用户凭据获取令牌时，若要查看数据，用户至少需要具有以下角色权限： ViewData 或 TvmViewData 。 有关详细信息，请参阅： 创建和管理角色。

要调用此 API，需要以下权限之一。 若要了解详细信息（包括如何选择权限），请参阅使用Microsoft Defender for Endpoint API。

权限类型 权限 权限显示名称
应用程序 Machine.Read.All 读取所有扫描信息。
委派（工作或学校帐户） Machine.Read.All 读取所有扫描信息。

HTTP 请求

POST api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId

请求标头

名称 类型 说明
Authorization String 持有者 {token}。 必需。
Content-Type string application/json. 必需。

请求正文

在请求正文中，提供具有以下参数的 JSON 对象：

参数 类型 说明
ScanDefinitionIds String 扫描 ID。 必需。

响应

如果成功，此方法返回 200 - 正常响应代码，并按定义列出扫描历史记录。

示例请求

下面是请求的示例。

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId

{
    "ScanDefinitionIds": ["4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae", "60c4aa57-c573-4488-8d18-230914792a92", "c6220f67-2cad-4ba3-a2fa-7ded6384da56"]
}

响应示例

{
"@odata.context": "https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId",
    "value": [
    {
    "ScanDefinitionIds": "4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae",
    "LastScanned": "2022-12-20T11:14:24.5561791Z",
    "ScanStatus": "Partial Success",
    "ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
    },
    {
    "ScanDefinitionIds": "60c4aa57-c573-4488-8d18-230914792a92",
    "LastScanned": "2022-11-17T15:13:24.5561791Z",
    "ScanStatus": "Partial Success",
    "ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
    },
    {
    "ScanDefinitionIds": "c6220f67-2cad-4ba3-a2fa-7ded6384da56",
    "LastScanned": "2022-11-10T18:15:24.5561791Z",
    "ScanStatus": "Partial Success",
    "ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
    },
   ]
}

示例$top请求

下面是仅返回 1 个会话的请求示例。

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId?$top=1

$top响应示例

{
"@odata.context": "https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId",
    "value": [
    {
    "ScanDefinitionIds": "4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae",
    "LastScanned": "2022-12-20T11:14:24.5561791Z",
    "ScanStatus": "Partial Success",
    "ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
    },
 ]
}
  • Last updated on